Skip to content

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 purpose
  • docs/architecture.md or equivalent — stack, constraints, and technical design
  • docs/runbook.md — operational instructions
  • docs/roadmap.md — planned work and direction
  • docs/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