This policy prevents information silos, making it easier to find information It evolvesĬontinuously, in keeping with new products and features, and with improvements Information related to GitLab implementation, usage, and troubleshooting. The GitLab documentation is the SSOT for all Documentation is the single source of truth (SSOT) The voice in the documentation should be conversational but brief, friendly but succinct. The goal is to provide information that’s easy to search and scan. Recent updates to this guide The GitLab voiceīuilding on that guidance, the voice in the GitLab documentation strives to be concise,ĭirect, and precise.Google Developer Documentation Style Guide.In addition to this page, the following resources can help you craft and contribute to documentation: If you have access to the GitLab Slack workspace, This document defines the standards for GitLab documentation, including grammar, formatting, word use, and more.įor style questions, mention in an issue or merge request. Feature flags Documentation Style Guide.Configuration documentation for source and Omnibus installations.Choose between an ordered or unordered list.Markdown rule MD044/proper-names (capitalization).The documentation includes all media types.The documentation includes all information.Documentation is the single source of truth (SSOT).
0 Comments
Leave a Reply. |