Technical Writing Fundamentals
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.
Start with the pre-class work ~12 short sessions.
GitLab Technical Writing Fundamentals slide deck
Use the slide deck to follow along with the recorded training sessions.
Session 1 (4 minutes)
Provides an introduction, the audience for the documentation, a brief recap of pre-class work, and the first grammar and style requirements.
Session 2 (8 minutes)
Reviews additional grammar and style requirements.
Session 3 (5 minutes)
Reviews even more grammar and style requirements and linting.
Session 4 (8 minutes)
Reviews topic types: concepts, tasks, references, troubleshooting (CTRT).
For more information
- Review the GitLab Documentation Style Guide.
- Review some examples for editing for topic types.
- Watch a related video for more examples.
- Provide suggestions or other feedback!
Schedule in-person training
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.
22b984c6
)