documentation
Documentation
Documentation is a product. Treat it with the same care as code: version it, review it, test it, maintain it.
Context
Documentation is a cross-cutting concern that applies at every lifecycle phase. Good documentation reduces onboarding time, prevents knowledge loss, and enables async collaboration. The Diataxis framework provides a useful structure.
In the phase matrix, documentation is always a must_consider concern. It only becomes a must_produce obligation when the change creates durable knowledge another person or later phase must rely on. Approved intake_mode=fast-track work may waive routine documentation updates, but it does not waive durable docs when the change would otherwise leave important knowledge implicit.
Diataxis Framework
Organize documentation into four types:
| Type | Purpose | Oriented to |
|---|---|---|
| Tutorial | Learning-oriented | Getting started, step-by-step |
| How-to Guide | Task-oriented | Solving specific problems |
| Reference | Information-oriented | Technical descriptions (API docs) |
More from yknothing/prodcraft
system-design
Use when reviewed requirements or specifications are ready and the team must decide high-level architecture, component boundaries, integration seams, or brownfield coexistence strategy before API design, technology selection, or task planning.
6ci-cd
Use when a reviewed implementation slice needs an automated build, test, and deployment pipeline, especially when brownfield rollback, release-boundary checks, contract/integration gates, and staged delivery must be explicit before shipping.
6intake
The mandatory gateway for all new engineering work. Triage and route new products, apps, features, migrations, tech-debt, or any 'not sure where to start' request to the correct lifecycle path. Use before starting design or implementation. Do not use for ongoing tasks, specific debugging, or PR reviews.
6feature-development
Use when a reviewed task slice has tests or acceptance targets and the team must turn it into a small, mergeable implementation increment without expanding scope, breaking contracts, or hiding release-boundary risk.
6monitoring-observability
Use when a live service or newly delivered release needs actionable telemetry, dashboards, and alerts that expose real user-impactful boundaries, especially when brownfield coexistence rules, unsupported-flow safety, rollback health, or queue/backfill behavior must be visible before incidents escalate.
6incident-response
Use when a live production issue needs coordinated containment, severity triage, stakeholder communication, and evidence capture, especially when a recent release, brownfield coexistence rules, rollback decisions, or unresolved contract boundaries must be handled before root-cause work.
6