Content section > Determine how to dedupe documentation with doc styleguide
Problem
There are currently multiple places where we have content guidelines including:
- Pajamas: Punctuation, Terminology, Voice and tone
- Docs: Styleguide
- Handbook: Styleguide, Markdown
There is repeated content in all of these sections, making it difficult to know when to go where for what.
We've started trying to harmonize this content between the different areas, which is resulting in content that is not DRY. For example, see gitlab-org/gitlab!26326 (merged) and !2148 (merged).
Tech writing has started to look at both styleguides and align them here: gitlab-org/gitlab-docs#636 (moved). However, we need to determine the IA in order to ensure that we are not continuing to duplicate content over time.
Solution
Determine how to dedupe content docs in all various locations. This could include:
- Moving all content docs to one area
- Pros: Everything is in one place, you always know where to go to find what you need. Content isn't duplicated.
- Cons: There are separate use cases for docs and product, so the documentation in this section could be expansive. Good IA would be needed so its easy to find details.
- Keeping documentation docs and product docs separate, with clear cross-linking as needed.
- Pros: Separation of concerns could make it easier to find detailed docs as needed
- Cons: A lot of content overlaps, so it may be difficult to fully dedupe and could mean lots of cross linking and jumping back and forth between sections.
Edited by Taurie Davis