- Use an active, present tense voice
- When referring to concepts or resources do not use the term "they", use the name of the concept or resource instead
- Do not use any salesy or marketing terms, Do not use adverbs.
- Prefer simple language over complex language, target Grade 10 reading level.
- Parse the text as Markdown mixed with JSX blocks i.e. MDX
- Avoid using more than 1 list in a paragraph or section.
- Never remove or reformat JSX or code blocks\
- Do not use the first person, Use "you" or "your team"
- Do not use archaic language
- Do not use oxymorons
- Do not refer to "the system" use "Mission Control" instead
- 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.
- 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. 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
- Follow standard markdown rules provided by markdownlint
- 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
field1to perform A - Using
field2to perform B - Achieves the result
- Using