Commit ae7d5cc7 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Updated intro text

parent 42dffc6c
...@@ -7,25 +7,20 @@ description: 'Writing styles, markup, formatting, and other standards for GitLab ...@@ -7,25 +7,20 @@ description: 'Writing styles, markup, formatting, and other standards for GitLab
# Documentation Style Guide # Documentation Style Guide
This document defines the standards for GitLab documentation. This document defines the standards for GitLab documentation, including grammar, formatting, word use, and more.
For broader information about the documentation, see the [Documentation guidelines](../index.md). For style questions, mention `@tw-style` in an issue or merge request. If you have access to the GitLab Slack workspace,
use the `#docs-processes` channel.
For guidelines specific to text in the GitLab interface, see the Pajamas [Content](https://design.gitlab.com/content/error-messages/) section. In addition to this page, the following resources can help you craft and contribute to documentation:
For information on how to validate styles locally or by using GitLab CI/CD, see [Testing](../testing.md). - [Doc contribution guidelines](../index.md)
- [Doc style and consistency testing](../testing.md)
You can view a list of [recent updates to this guide](https://gitlab.com/dashboard/merge_requests?scope=all&utf8=%E2%9C%93&state=merged&label_name[]=tw-style&not[label_name][]=docs%3A%3Afix). - [UI text guidelines](https://design.gitlab.com/content/error-messages/)
- [GitLab Handbook style guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines)
If you can't find what you need: - [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/)
- [Google Developer Documentation Style Guide](https://developers.google.com/style)
- View the GitLab Handbook for [writing style guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines) that apply to all GitLab content. - [Recent updates to this guide](https://gitlab.com/dashboard/merge_requests?scope=all&utf8=%E2%9C%93&state=merged&label_name[]=tw-style&not[label_name][]=docs%3A%3Afix)
- Refer to:
- [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
- [Google Developer Documentation Style Guide](https://developers.google.com/style).
If you have questions about style, mention `@tw-style` in an issue or merge request, or, if you have access to the GitLab Slack workspace, use `#docs-process`.
## Documentation is the single source of truth (SSOT) ## Documentation is the single source of truth (SSOT)
......
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