Skip to main content

Contributing

Choose the right collection​

Put a page where its primary user will look for it. Prefer linking over copying. If content is temporary evidence rather than durable knowledge, keep it near the work until it has been synthesized.

Use explicit lifecycle metadata​

Start from the document template and set:

  • owner: the person or team accountable for accuracy
  • status: draft, review, approved, deprecated, or archived
  • last_reviewed: the most recent meaningful review date
  • review_by: the next review date when freshness is time-sensitive

Write for retrieval​

Use descriptive titles, put the answer first, define internal terms, and include the words a teammate would search for. Link claims to their source when the source is not obvious.

Review before publishing​

Check factual accuracy, permissions, sensitive data, duplicate guidance, broken links, and whether the named owner accepts responsibility. Then run pnpm check.