This project uses a small, practical documentation structure built around
arc42, Architecture Decision Records, project guidelines, and a shared domain glossary.
The goal is to keep architecture knowledge close to the code, record important decisions while they are still fresh, and maintain a stable vocabulary for the agentfiles bounded context.
The documents in this folder are intentionally incremental: they describe the current implementation first, then evolve as the system grows.
- Architecture: the
arc42architecture set for the current system - ADRs: durable records of important architectural decisions
- Guidelines: cross-cutting development and design conventions
- Glossary: canonical definitions for project domain terms
Each folder contains a README.md file that outlines how to use the folder contents and what you need to look at in order to work effectively.
Make sure when the implementation changes in a way that affects architecture, update the matching arc42 chapter and add new ADR(s) if the change records a meaningful decision.
Make sure that when the team wants to standardize how work should be done, add or update a guideline.
Make sure that when a term changes meaning or a new domain term appears, you update the glossary.