Documentation
README
Model the domain
Build a precise shared understanding of the concepts that matter to the current decision. Read existing glossaries, context maps, ADRs, code, and tests when they provide relevant evidence.
Sharpen the model
- Identify overloaded terms, hidden distinctions, and conflicting definitions.
- Use concrete scenarios and edge cases to test whether concepts and boundaries hold.
- Compare the stated model with behavior in the code and surface material contradictions.
- Propose clear language when ambiguity is blocking progress, while respecting established repository terminology that remains accurate.
Ask the user to resolve a term only when their intent cannot be inferred safely and the distinction affects the outcome.
This is the opening of the README. Read the full README on GitHub.