Warship Living Docs

2. Extract ground-truth facts from code:

• Exact route paths and HTTP methods
• Query/body params with defaults
• Response fields and value semantics
• Data source origin (table/view/workbook/sheet)

3. Update the right documentation targets:

• Route catalog sections
• Data contract sections
• Architecture flow notes
• Operational caveats and assumptions

4. Add unit and timeframe annotations:

• lbs vs weight
• dollars vs c/lb
• monthly vs YTD vs full-year
• exclusions (partial year, missing sheet, etc.)

5. Add change note:

• Date
• Files reviewed
• What was added, updated, removed
• Open questions

Quality Gate (must pass)

• No undocumented new endpoint remains.
• No stale endpoint references remain.
• All numeric fields have units where needed.
• All data-source claims map to actual code paths, tables, or files.
• Ambiguities are listed explicitly as unresolved.

Output Format

• Summary
• Documentation files updated
• Endpoint/data-contract deltas
• Open assumptions and questions