contributor docs: Extend help center writing style documentation.

This commit is contained in:
Alya Abbott 2024-04-30 15:29:53 -07:00 committed by Tim Abbott
parent 8fb7ab84e6
commit a302278987
1 changed files with 11 additions and 1 deletions

View File

@ -213,7 +213,17 @@ feature's name followed by the feature itself (e.g. **Settings** page,
used. Use **bold** for stream names, and quotation marks for topic names.
Keep in mind that the UI may change — dont describe it in more detail than
is needed. **Never identify or refer to a button by its color.**
is needed. In particular:
- Do not specify what the default configuration is. This might change in the
future, or may even be different for different types of organizations.
- Do not list out the options the user is choosing from. Once the user finds the
right menu in the UI, they'll be able to see the options. In some cases, we
may describe the options in more detail outside of the instructions block.
- Never identify or refer to a button by its color. You _can_ describe its
location.
- Use screenshots only when it's very difficult to get your point across without
them.
### Voice