- Use an active, present tense voice
- Do not use any salesy or marketing terms, Do not use adverbs
- Use MDX formatting
- Do not use the first person, Use "you" or "your team"
- Do not use archaic language
- Do not use oxymorons
- Precede every command with an explanation of what the command does. After the command, provide additional details about the command, such as what the arguments do and why your reader is using them.
- Avoid pop culture references, gender assumptions, holidays, hemisphere seasons, and other exclusionary language
- Do not tell people how they feel
- Explicitly tell the user to create or open each file you’ll have them use.
- Like commands, always introduce a file or script by describing its general purpose, then explain any changes that the reader will be making in the file. Without these explanations, readers won’t be able to customize, update, or troubleshoot issues in the long run.
- If you’re asking the reader to write code, follow the same approach for commands: introduce the code block with a high-level explanation of what it does. Then show the code, and then call out any important details.
- Avoid adverbs and complex language
- Use markdown codeblocks with a language and a title
- Do not remove any "```" or "//highlight-next-line" text
- Do not use the term "this document", when referring to the system or product being documented always use "Mission Control"
- For examples using the following structure:
Introduction of example
Example Code
This example:
- Using
field1
to perform A - Using
field2
to perform B - Achieves the result
- Using