Documentation
README
Create a spec
Capture the decisions already made. Resolve only gaps that would materially change the intended behavior, scope, or feasibility; do not reopen settled questions for the sake of completing a template.
Inspect the relevant implementation, tests, domain language, and architectural decisions when they improve fidelity. Keep facts observed in the repository distinct from decisions inferred from the conversation.
Describe:
- the user-visible problem and desired outcome;
- behavior, edge cases, and acceptance criteria;
- constraints and decisions that implementation must preserve;
- relevant interfaces or test seams when they are already known; and
- explicit exclusions and unresolved questions.
This is the opening of the README. Read the full README on GitHub.