keymodels
Documentation style guide
What writing, structure, terminology, procedure, and review standards should documentation follow?
Template preview
Start with a clear working structure.
The documentation style guide turns a recurring piece of work into a record that another person can understand and continue. The working view makes voice, words, and headings visible so discussion can move from general opinion to a specific action or decision.
Complete voice with the specific fact, choice, evidence, owner, and review implication required by the documentation style guide. Complete words with the specific fact, choice, evidence, owner, and review implication required by the documentation style guide. Complete the remaining items so this section is ready for review and use.
Complete callouts with the specific fact, choice, evidence, owner, and review implication required by the documentation style guide. Complete glossary with the specific fact, choice, evidence, owner, and review implication required by the documentation style guide. Complete the remaining items so this section is ready for review and use.
Continue your preview
Read more of Documentation style guide.
Create a free account to continue this advanced template preview. Complete access is included in Pro and Team, so you can see the value before deciding to upgrade.