Commit d30ae952 authored by Ray Paik's avatar Ray Paik

Merge branch 'patch-105' into 'master'

Update styleguide.md as suggested in #215683

See merge request gitlab-org/gitlab!30756
parents 6b5010f1 2d90f03e
...@@ -17,7 +17,7 @@ that apply to all GitLab content, not just documentation. ...@@ -17,7 +17,7 @@ that apply to all GitLab content, not just documentation.
### Why a single source of truth ### Why a single source of truth
The documentation of GitLab products and features is the SSOT for all information related to implementation, usage, and troubleshooting. It evolves continually, in keeping with new products and features, and with improvements for clarity, accuracy, and completeness. The documentation of GitLab products and features is the SSOT for all information related to implementation, usage, and troubleshooting. It evolves continuously, in keeping with new products and features, and with improvements for clarity, accuracy, and completeness.
This policy prevents information silos, making it easier to find information about GitLab products. This policy prevents information silos, making it easier to find information about GitLab products.
...@@ -46,12 +46,12 @@ In the software industry, it is a best practice to organize documentation in dif ...@@ -46,12 +46,12 @@ In the software industry, it is a best practice to organize documentation in dif
1. Explanation 1. Explanation
1. Reference (for example, a glossary) 1. Reference (for example, a glossary)
At GitLab, we have so many product changes in our monthly releases that we can't afford to continually update multiple types of information. At GitLab, we have so many product changes in our monthly releases that we can't afford to continuously update multiple types of information.
If we have multiple types, the information will become outdated. Therefore, we have a [single template](structure.md) for documentation. If we have multiple types, the information will become outdated. Therefore, we have a [single template](structure.md) for documentation.
We currently do not distinguish specific document types, although we are open to reconsidering this policy We currently do not distinguish specific document types, although we are open to reconsidering this policy
once the documentation has reached a future stage of maturity and quality. If you are reading this, then despite our once the documentation has reached a future stage of maturity and quality. If you are reading this, then despite our
continual improvement efforts, that point hasn't been reached. continuous improvement efforts, that point hasn't been reached.
### Link instead of summarize ### Link instead of summarize
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment