Skip to content

Documentation Best Practices

Core rules

  • Write for the next person who has no context.
  • Keep each page focused on one job.
  • Prefer examples over abstract explanation.
  • Use consistent terminology.
  • Delete or merge stale pages instead of piling on duplicates.

Team habits

  • Assign page ownership.
  • Review docs alongside code changes.
  • Update docs during feature work, not after it drifts.
  • Treat examples as part of the product.

Markdown-first documentation for teams that update docs often.