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 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 and other subjects according to the tables below.
The designated technical writer is the go-to person for their assigned stage groups. 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.
The backup writer is assigned to cover merge request reviews and urgent matters for the designated tech writer when they are out (vacations, sickness, and any other temporary leave). They can also naturally pair to work together on complex issues when needed.
Note that there are some planned changes to these assignments.
|Dev||Plan||Project Management||Marcin Sędłak-Jakubowski||---|
|Dev||Plan||Portfolio Management||Marcin Sędłak-Jakubowski||---|
|Dev||Create||Source Code||Marcia Ramos||---|
|Dev||Create||Static Site Editor||Marcia Ramos||---|
|CI/CD||Verify||Continuous Integration||Marcel Amirault||---|
|Secure||Secure||Static Analysis||Nick Gaskill||---|
|Secure||Secure||Dynamic Analysis||Nick Gaskill||---|
|Secure||Secure||Composition Analysis||Nick Gaskill||---|
|Secure||Secure||Attack Surface||Nick Gaskill||---|
|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 in other projects and subjects:
|Development guidelines (1)||Marcia Ramos||TBA|
|GitLab Docs - frontend||Marcia Ramos||TBA|
|GitLab Docs - backend||Axil||TBA|
|GitLab Runner||Marcel Amirault||Evan Read|
|GitLab Development Kit (GDK)||Evan Read||TBA|
|GitLab Pages Daemon||TBA||TBA|
|GitLab Pages Examples||Axil||TBA|
|Technical writing handbook||Mike Lewis|
(1) Note: Development guidelines refer to the docs under
If the changes to this section introduced in an MR are specifically related to a stage group,
the technical writer assigned to that group should perform the review and CC
for her information.
While the technical writer is onboarding, they will be assigned to shadow groups and then start contributing as trainees, as described below. Veteran technical writers will coach them through the process.
To consult the current assignments, see the onboarding technical writers spreadsheet.
For the first release cycle that begins after the new member start
date, they will shadow (read) their buddy's work in their most active
Stage Group, plus one other stage group/writer decided with the
tech writing manager and the team. Veteran technical writers will
proactively share relevant issues, merge requests, and communications
with their shadows by using a
Slack channel, creating it if it doesn't already exist, and answering questions.
For the second release cycle that begins after the new member's start date, unless the tech writing manager extends the shadowing phase, they will act as a trainee on one or more groups as assigned by the manager. The intent is to take on the group as its technical writer as of the next release. The veteran technical writer who is assigned to that Group will assign substantial parts of the work to the new member for this group, which accounts to roughly half of the groups's reviews of MRs with docs, UI text, and release post content; a small but substantial documentation authoring project; a few minor doc improvement projects/fixes.
For the third release cycle, the onboarding tech writer assumes the full role of technical writer for their assigned group, except that they will not yet have merge rights. The former TW assigned to the group is now the coach, who will review all their work (including reviews they perform of other authors) before merging it or approving it for another maintainer to merge. They may share the burden of these reviews with other technical writers.
Technical writers are assigned for merge request reviews (of both team members and community contributors) according to the stage groups they are assigned.