Purpose
Documentation exists at three levels, and each has a home.
The standard
Level | Where | Contains |
|---|---|---|
Team standard (how we do X) | This wiki | Rules and procedures that apply across tools |
Tool docs (how to use/run Y) | Repo README + | Setup, usage, architecture of that one tool |
Code docs | Docstrings, comments, CLAUDE.md | Why, not what |
Every repo README has: one-line purpose, owner, how to run locally, how to deploy, link to its wiki catalog page.
Wiki pages: written in second person, imperative mood, one procedure per page, screenshots cropped and captioned (
FIG. n — caption).Every page shows an owner and a last-reviewed date; owners review their pages every
[TEAM: 6 months].Write for the person who joins next month, not for yourself.
Procedure — adding a page
Find the right section; if none fits, propose one in
#dev.Copy the page template (Purpose / Standard / Procedure / Examples / Owner).
Publish, then link the page from any related tool README.
Owner: Matt · Last reviewed: 2026-09