Blame
|
1 | # Template — Product Documentation |
||||||
| 2 | ||||||||
| 3 | > Copy this structure into a new product directory; this page itself is not a product record. |
|||||||
| 4 | ||||||||
| 5 | ## Index |
|||||||
| 6 | ||||||||
| 7 | Purpose, audience, lifecycle status, repository and links to the main reference pages. |
|||||||
| 8 | ||||||||
| 9 | ## Current Status |
|||||||
| 10 | ||||||||
| 11 | Baseline branch/commit, verification date, supported surface, newest material changes and known documentation discrepancies. |
|||||||
| 12 | ||||||||
| 13 | ## Getting Started |
|||||||
| 14 | ||||||||
| 15 | Smallest repeatable path from zero to a validated working installation/development environment. |
|||||||
| 16 | ||||||||
| 17 | ## Architecture |
|||||||
| 18 | ||||||||
| 19 | Boundaries, identity/data model, dependencies and a diagram where useful. |
|||||||
| 20 | ||||||||
| 21 | ## Reference |
|||||||
| 22 | ||||||||
| 23 | Configuration, commands/API, persistence/data, authentication/security, compatibility/version support. |
|||||||
| 24 | ||||||||
| 25 | ## Operations |
|||||||
| 26 | ||||||||
| 27 | Deployment/release, monitoring, backup/restore, common failures and recovery procedures. |
|||||||
| 28 | ||||||||
| 29 | ## Development |
|||||||
| 30 | ||||||||
| 31 | Module map, build/test commands, CI expectations and source-reference links. |
|||||||
| 32 | ||||||||
| 33 | ## Roadmap |
|||||||
| 34 | ||||||||
| 35 | Future work clearly labelled as planning, with completed behaviour moved into reference pages. |
|||||||