Skip to content

Commit b994a07

Browse files
authored
docs: add guidance for project documentation capture (anomalyco#355)
1 parent e2d78d6 commit b994a07

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,12 @@ Troubleshoot failures: check test isolation → verify mocks → fix implementat
9292
1. **Plan** — Use planner agent, identify dependencies and risks, break into phases
9393
2. **TDD** — Use tdd-guide agent, write tests first, implement, refactor
9494
3. **Review** — Use code-reviewer agent immediately, address CRITICAL/HIGH issues
95-
4. **Commit** — Conventional commits format, comprehensive PR summaries
95+
4. **Capture knowledge in the right place**
96+
- Personal debugging notes, preferences, and temporary context → auto memory
97+
- Team/project knowledge (architecture decisions, API changes, runbooks) → the project's existing docs structure
98+
- If the current task already produces the relevant docs or code comments, do not duplicate the same information elsewhere
99+
- If there is no obvious project doc location, ask before creating a new top-level file
100+
5. **Commit** — Conventional commits format, comprehensive PR summaries
96101

97102
## Git Workflow
98103

‎examples/user-CLAUDE.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@ Located in `~/.claude/agents/`:
7979
- 80% minimum coverage
8080
- Unit + integration + E2E for critical flows
8181

82+
### Knowledge Capture
83+
- Personal debugging notes, preferences, and temporary context → auto memory
84+
- Team/project knowledge (architecture decisions, API changes, implementation runbooks) → follow the project's existing docs structure
85+
- If the current task already produces the relevant docs, comments, or examples, do not duplicate the same knowledge elsewhere
86+
- If there is no obvious project doc location, ask before creating a new top-level doc
87+
8288
---
8389

8490
## Editor Integration

0 commit comments

Comments
 (0)