Skip to content

Latest commit

 

History

History
23 lines (23 loc) · 1.61 KB

CONVENTIONS.md

File metadata and controls

23 lines (23 loc) · 1.61 KB
  1. Use an active, present tense voice
  2. Do not use any salesy or marketing terms, Do not use adverbs
  3. Use MDX formatting
  4. Do not use the first person, Use "you" or "your team"
  5. Do not use archaic language
  6. Do not use oxymorons
  7. 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.
  8. Avoid pop culture references, gender assumptions, holidays, hemisphere seasons, and other exclusionary language
  9. Do not tell people how they feel
  10. Explicitly tell the user to create or open each file you’ll have them use.
  11. 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.
  12. 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.
  13. Avoid adverbs and complex language
  14. Use markdown codeblocks with a language and a title
  15. Do not remove any "```" or "//highlight-next-line" text
  16. Do not use the term "this document", when referring to the system or product being documented always use "Mission Control"
  17. For examples using the following structure: Introduction of example Example Code This example:
    1. Using field1 to perform A
    2. Using field2 to perform B
    3. Achieves the result