-
-
Couldn't load subscription status.
- Fork 13
Description
For consistent documentation, we need a style guide. Typically this would cover formatting and capitalization rules (things that are immediately visible) as well as tone/writing style rules such as "Are we using 'we' or 'you' for instructional texts?" This also covers the formatting of code blocks.
In this ticket, the content and its structure are explicitly out of scope.
This guide will then apply to every documentation document. Reference documentation, tutorials, guides etc.
It is also a guide, writers and reviewers should use their own best judgement when writing/reviewing documentation.
The main driver behind this was that I noticed a wide range of superficial formatting styles (when to capitalize, starting command line snippets with a prompt or not, active or passive voice, contractions, ...) which makes the documentation inconsistent on a surface level, making me trust the documents less.
Some resources on this I have gathered so far:
- Write The Docs overview on style guides
- Google developer documentation style guide
- Gitlab style guide
- Kubernetes: Documentation style overview
Acceptance criteria
- have decided on a style guide to use (or written our own)
- A page in the Contributor's Guide is added to show how to write documentation