Skip to content

Writing rules

  • Write short sentences in the second person. Start steps with a verb.
  • One task per page. If a page is longer than about two screens, split it.
  • Show before you tell: put a figure or screenshot near the top.
  • Name interface elements exactly as the English app does (src/i18n/catalogs/en/), and follow docs/i18n-glossary.md for trade terms.
  • Write only what the code or the internal docs confirm. Mark anything else as a draft.
  • Do not end a page with a summary of itself.
  • The en dash and the em dash. Use a comma, a colon or a new sentence.
  • Marketing filler words and stock AI phrases. The list is BANNED in site/scripts/checks/prose.mjs.
  • Rows of emoji, and closing headings such as “Summary” or “Conclusion”.
  • Missing or wrong frontmatter, a description over 155 characters, and related links to pages that do not exist.
  • A processing type without a page, and an example that does not validate.

The check also warns about pages over about 900 words.