mirror of
https://github.com/RooVetGit/Roo-Code.git
synced 2026-09-17 23:51:08 +00:00
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
# INT-007 — Documentation & Knowledge Base
|
|
|
|
## Intent
|
|
Maintain comprehensive documentation for the Intent-Code Traceability system, including architecture notes, API documentation, and a persistent knowledge base.
|
|
|
|
## Scope (owned_scope)
|
|
- `ARCHITECTURE_NOTES.md`
|
|
- `README.md` (Intent-Code Traceability section)
|
|
- `.orchestration/AGENT.md`
|
|
- `docs/intent-traceability/`
|
|
- `CHANGELOG.md` (relevant entries)
|
|
|
|
## Constraints
|
|
- `ARCHITECTURE_NOTES.md` must document all injection points and hook integration.
|
|
- `AGENT.md` must be append-only knowledge base for "Lessons Learned".
|
|
- Documentation must be kept in sync with code changes.
|
|
- API documentation must include examples for each public method.
|
|
|
|
## Acceptance Criteria
|
|
- `ARCHITECTURE_NOTES.md` includes:
|
|
- Tool execution flow diagram
|
|
- Hook injection points with line numbers
|
|
- System prompt modification points
|
|
- Data model schemas
|
|
- `AGENT.md` includes:
|
|
- Lessons learned from implementation
|
|
- Common pitfalls and solutions
|
|
- Performance optimizations
|
|
- Stylistic rules for intent specifications
|
|
- README includes setup instructions and usage examples.
|
|
- All public APIs are documented with JSDoc comments.
|
|
- Documentation is reviewed and updated with each major change.
|
|
|