Clarify purpose of CONTEXT.md to emphasize it as a glossary, removing implementation details
This commit is contained in:
parent
f304057d61
commit
e74f0061bb
1 changed files with 1 additions and 1 deletions
|
|
@ -73,7 +73,7 @@ When the user states how something works, check whether the code agrees. If you
|
|||
|
||||
When a term is resolved, update `CONTEXT.md` right there. Don't batch these up — capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
|
||||
|
||||
Don't couple `CONTEXT.md` to implementation details. Only include terms that are meaningful to domain experts.
|
||||
`CONTEXT.md` should be totally devoid of implementation details. Do not treat `CONTEXT.md` as a spec, a scratch pad, or a repository for implementation decisions. It is a glossary and nothing else.
|
||||
|
||||
### Offer ADRs sparingly
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue