Currently, we are developing our documentation style guide. While we have some recommended rules and guidelines to follow, we lack examples. This can lead to loss of accessibility around some parts that we wish to communicate with the readers. Ideally, we would like to fix it.
manojtummala
commented
3 years ago
What is the current documentation state?
Currently, we are developing our documentation style guide. While we have some recommended rules and guidelines to follow, we lack examples. This can lead to loss of accessibility around some parts that we wish to communicate with the readers. Ideally, we would like to fix it.
Where is this stated?
https://docs.moja.global/en/latest/DocumentationStyleGuide/language-grammar/capitalization.html
Why do you want to improve the statement?
Add 3-5 examples of DO's and DONT's as part of the style guide as a table so that it is easy for readers to review recommended examples. Take a look at the examples for Clauses here: https://docs.moja.global/en/latest/DocumentationStyleGuide/language-grammar/clauses.html
Proposed Statement
No response
Additional context.
No response