document
After implementing a new feature or fixing a bug, make sure to document the changes. Use when writing documentation, after finishing the implementation phase for a feature or a bug-fix.
Documentation Process
Conventions
Read capy knowledge base conventions at shared-capy-knowledge-protocol.md.
Guidelines
Capy search: Before writing docs, search kk:arch-decisions and kk:project-conventions for decisions that should be reflected in documentation — decisions not obvious from code alone.
- After completing a new feature, always see if you need to update the Architecture documentation at
/docs/contributing/ARCHITECTURE.mdand Test documentation in/docs/contributing/TESTING.mdfor other developers, so anyone could easily pick up the work and understand the project and the feature that was added. - If the code change included prior decision-making out of several alternatives, document an ADR at
/docs/adrfor any non-trivial/non-obvious decisions that should be preserved.