Improvements to Documentation style and structure information
What does this MR do?
Main goal: Add a heading to make this clear in Documentation page about how we organize docs, ensure SSOT and link (across main documentation page and style guide)
Ensure we cover SSoT, one/multi format (no guides, glossary, howto), multimedia use
Improve headers and potentially organization of content in
https://docs.gitlab.com/ee/development/documentation/#documentation-directory-structure
https://docs.gitlab.com/ee/development/documentation/#location-and-naming-documents
Multimedia (include video, vector graphics/diagrams, etc.)
Handbook crosslinks https://about.gitlab.com/handbook/documentation https://about.gitlab.com/handbook/product/technical-writing/
Related issues
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the ~Documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.