Warship Living Documentation
Purpose
Maintain continuously accurate project documentation that evolves with code.
Use When
- New route is added, removed, or renamed.
- Endpoint request or response shape changes.
- SQL logic, table/view source, or Excel parsing logic changes.
- Template behavior or page workflow changes.
- Operational assumptions (units, date windows, YTD rules) change.
- Target changed files or route names.
- Scope of documentation update (API docs, architecture, runbook, all).
Procedure
- Identify impacted components:
- Routers
- Schemas
- Templates
- Data scripts