The primary goal of the Technical Writing team is to continuously develop GitLab's product documentation content to meet the evolving needs of all users and administrators.
Documentation is intended to educate readers about features and best practices, and to enable them to efficiently configure, use, and troubleshoot GitLab. To this end, the team also manages the docs.gitlab.com site and related process and tooling.
Our team comprises:
Technical writers partner with anyone in the GitLab community who is concerned with documentation, especially developers, who are typically the first to update docs for the GitLab features that they code.
For more information on documentation at GitLab, see:
The team is broadly responsible for the following at GitLab.
Documentation Content, including:
Documentation Site (docs.gitlab.com) including maintaining and enhancing the documentation site’s:
Documentation Process, including:
This work is sorted into the top-level Documentation epics linked above.
Technical writers (aka "TWs" or "docs team") are assigned to and collaborate with other teams and groups as described in the DevOps stages table below.
Each writer is the go-to person for their assigned stage group. They collaborate with other team members to plan new documentation, edit existing documentation, review any proposed changes to documentation, suggest changes to the microcopy exposed to the end-user, and generally partner with subject matter experts in all situations where documentation is required.
|Dev||Plan||Project Management||Russell Dickenson|
|Dev||Plan||Portfolio Management||Russell Dickenson|
|Dev||Create||Source Code||Marcia Ramos|
|CI/CD||Verify||Continuous Integration||Marcel Amirault|
|CI/CD||Release||Progressive Delivery||Marcia Ramos|
|CI/CD||Release||Release Management||Marcia Ramos|
|Defend||Defend||Runtime Application Security||Axil|
|Defend||Defend||Application Infrastructure Security||Axil|
For collaboration not related to the DevOps stages:
|Development guidelines||Marcia Ramos|
|Technical writing handbook||Mike Lewis|
Technical writers are assigned for merge request reviews (of both team members and community contributors) according to the stage groups they are assigned.