The following page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features or functionality remain at the sole discretion of GitLab Inc.
Maturity | N/A |
Content Last Reviewed | 2024-2-15 |
Maintained by | Susan Tacker |
Our goal is to provide documentation that is accurate, helpful, and easy to use. It should help users perform their jobs efficiently and be easy to browse or search for the information they need. As open source documentation, it should be easy to contribute to the documentation itself.
All standards and practices for contributing documentation are in the GitLab Documentation guidelines section of the docs site.
Who uses the docs site?
GitLab Users: GitLab administrators and users on self-managed and SaaS require clear and comprehensive documentation. The percentage of visitors who are not GitLab administrators continues to increase year over year, and the percentage of people who use the docs site daily continues to grow at an average rate of 3% per year.
GitLab Team Members: GitLab team members are both contributors to and consumers of the documentation. While the Technical Writing team owns the documentation, anyone can and does contribute to the docs.
The percentage of new-to-GitLab users and first-time docs site users continues to grow sharply. We focus many docs site efforts on people who could benefit from easy-to-find, basic "how-to" information.
UX research highlights key opportunities for improving the GitLab documentation site:
/help
and docs.gitlab.com are different sites with different experiences of similar content, which confuses usersThe Documentation Roadmap epic lists ongoing projects to help improve the docs site experience.
As outlined in the Documentation Roadmap and in quarterly OKRs, we've prioritized a number of improvements to address the challenges listed above.
The Technical Writing team is not currently investing in localization of the documentation. Replatforming the docs site is a higher priority, however the Globalization and Localization team has begun foundational work for future localization of the documentation.
Currently, the GitLab Documentation Site category is a non-marketing category, which means its maturity does not get tracked.