Repo Documentation Standard¶
Each in-scope repository should keep implementation-coupled documentation in the repository where the work actually lives.
Required local documentation¶
README.md— repository overview and purposedocs/architecture.mdor equivalent — stack, constraints, and technical designdocs/runbook.md— operational instructionsdocs/roadmap.md— planned work and directiondocs/user-stories.md— user stories, workflows, or intended behaviors
Catalog boundary¶
The platform catalog should not replace repository-local technical documentation.
Use this catalog for: - cross-repo inventory - naming rules - architecture relationships - lifecycle and ownership context - links to repo-local documentation