[PROJECT NAME] Architecture

[ONE-PARAGRAPH LEDE — what is this system, in 2–3 sentences.]

System topology

grounded in [GROUNDING SOURCES — e.g. package.json · docker-compose.yml · src/]
[@pkg/cli]
[framework · binary]
  • [command group 1]
  • [command group 2]
[@pkg/service-a]
[role line]
  • [responsibility 1]
  • [responsibility 2]
[store-1]
[driver · migrations]
[store-2]
[role line]
[@pkg/service-b]
[role line]
[Group 1]
  • [item]
  • [item]
[Group 2]
  • [item]
  • [item]
[Group 3]
  • [item]
  • [item]
[External API]
[sdk · models]
[@pkg/types]
[schemas · shared types · consumers]
[PROJECT NAME] component connection overlay Directional edges between the architecture nodes: entry invocation (blue), persistence access (muted), cross-plane reads (green dashed), external API calls (orange), shared-library references (purple dotted). cli [edge label] [sdk name]

Component details

[Plane A story]

  • [claim]
  • [constraint or invariant]
  • [mechanism with code]
  • [operational property]

[Plane B story]

  • [claim]
  • [mechanism]
  • [budget / limit]
  • [hand-off rule]

[CLI / entry story]

  • [claim]
  • [claim]
  • [claim]

[Shared library story]

  • [claim]
  • [claim]
  • [claim]

[External surface story]

  • [claim]
  • [claim]

Tooling

  • [build + test stack]
  • [CI gates]
  • [release process]

[PROJECT NAME] · [REPO URL] · generated [DATE]