Skip to main content

Writing style guide

Adapted from the MDN writing style guide for this knowledge base: clear, concise, consistent.

Core ideas​

  • Know your audience and match difficulty within a domain.
  • 3C: clearly, concisely, consistently.
  • Use 1–3 intro paragraphs before the first heading: scope, outcome, prerequisites.
  • Add runnable examples; use fenced code with optional title.
  • Prefer inclusive wording.

Admonitions (like MDN notes)​

:::note
Supplementary context.
:::

:::warning
Use for investing, health, or legal cautions.
:::

See also Principles, Outline, Monetization.