Handbook: Documentation as product usage SSOT, docs-first approach, related forum use
Handbook-related items in response to December 2018 Support conversation and follow up meeting.
In addition to documentation site epic &35 (closed) & changes to the 'contributing to documentation' docs (https://gitlab.com/gitlab-org/gitlab-ce/issues/55595 / https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/23951)
-
Add Documentation section to handbook !17635 (merged) :
-
Cover the mission of the docs, what belongs, and docs as SSOT / docs-first -
Link to this from first bullet in https://about.gitlab.com/handbook/handbook-usage/#scope-of-this-handbook -
Things that belong in docs include the following (with needed context/caveats): -
Workarounds for a single release/time period; Niche workarounds; Code that could be ‘dangerous’ to run without reading the fully detailed warnings we provide
-
-
Add to the Communication page https://about.gitlab.com/handbook/communication/ :
-
Documentation Subsection - Docs as SSOT -
Forum Subsection - User generated content. Monitored by the Community Advocates. Refrain from replying with repeatable steps and information that could otherwise be included in docs. If your reply is specific to the user but you are able to re-use some of the information in GitLab Documentaiton, submit an MR immediately. It does not need to be perfect. See: Docs as SSOT. -
Link to new Forum section from https://about.gitlab.com/handbook/marketing/community-relations/community-advocacy/workflows/forum.html
-
Rework product/technical-writing
section to be more about the team. Can move some of the team details from the new /documentation page here.
Edited by Mike Lewis