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. The 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.
Technical writers partner with anyone in the GitLab community who is concerned with documentation, especially developers, who are the first to update docs for the GitLab features that they code.
For more information on documentation at GitLab, see the Documentation section of the Handbook.
New Content Development - Leading the planning and authoring of new content to better meet user needs. This will be a significantly increased proportion of the team’s work, and will make use of improved methods and standards.
Authoring docs that better address use cases with A-to-Z process flows, going beyond existing feature references and procedures that can be difficult to adapt to real-world use cases. Supported by updated standards for content types and structure.
Getting Started - a.k.a. unboxing or onboarding docs for various audiences and scenarios.
Revamping existing content pages/sections, so that they meet our latest standards, including contextual information on every page (what, why, who).
Improve use of documentation feedback/sensing mechanisms. Improved sourcing and channeling/triage; making use of existing comments and issues, while bringing in new sources including search data, surveys, user testing, etc.