Decide what and when to write down, and produce Architecture Decision Records (ADRs), one-pagers, runbooks, and decision logs. Use when the user asks whether something should be documented, wants to write an ADR, needs a runbook or operational playbook, wants to keep a decision log, or is trying to decide between a one-pager and an RFC. NOT for auto-generating docs from code (use documentation-gen
Receba novas skills de Escrita e Conteúdo toda segunda
1 email curto, só com as skills novas de Escrita e Conteúdo. 4 minutos de leitura, sem spam, cancela com 1 clique.
Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.
Ler descrição completaRecolher descrição
Documentation Discipline
Under-documentation forces re-discovery. Over-documentation forces maintenance. The discipline is to write what will be re-used, at the altitude it will be re-used, and to let the rest stay in chat.
What to write down (the decision tree)
Is the question likely to be asked again?
├── No → don't document (Slack thread is fine)
└── Yes → keep going ↓
Is the answer likely to change often?
├── Yes → runbook or FAQ (owned + dated)
└── No → keep going ↓
Is the a
[Description truncada. Veja o README completo no GitHub.]