The Technical Writing Fundamentals course is available to help both GitLab and community contributors write and edit documentation for the product. This course provides direction on grammar and topic design.
This class is not required to contribute to docs.gitlab.com. Everybody can contribute!
You can review the training materials on this page, or you can take the course in Level Up.
Technical Writing Fundamentals course
The Technical Writing Fundamentals course consists of the following sections to be completed in order.
Google Technical Writing One pre-class material
Complete the pre-class exercises from this excellent Google training. You can take the associated Google class if you like, but the GitLab Technical Writing Fundamentals sessions 1-4 cover the information that is relevant for GitLab.
While we emphasize asynchronous training, in-person training for GitLab team members is available on a limited basis. Contact Susan Tacker (@susantacker in Slack) to schedule training sessions.
We often write pages of documentation that contain disparate kinds of information.
We want to make sure we’re telling readers everything they need to know.
However, research shows that information is easier to digest if it’s presented in
repeatable patterns, so at GitLab we’re moving toward using industry-standard
topic types.
Each topic, or section on a page under a heading, should be identifiable as a concept, task, reference, or
troubleshooting topic. This structure helps our users recognize patterns and
makes both searching and scanning more efficient.
