Mortdecai
9ff8e915b8
User-agnostic, shareable AI-assisted development workflow distilled from 26+ real projects. Includes 9 composable rules, 4 project templates, pre-push secret scanning hook, 3 methodology guides, and customization docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# Context Document Maintenance
|
|
|
|
When creating new scripts, tools, commands, or changing how existing systems work,
|
|
immediately update the relevant context documents (CLAUDE.md, README, etc.) so
|
|
future sessions know about the change.
|
|
|
|
Don't leave context docs stale. The next session reads CLAUDE.md first -- if it
|
|
doesn't mention a tool, the tool effectively doesn't exist for the AI assistant.
|
|
|
|
## What to Update
|
|
|
|
| Change | Update |
|
|
|--------|--------|
|
|
| New script or tool created | Add to CLAUDE.md with usage |
|
|
| Existing tool behavior changed | Update CLAUDE.md entry |
|
|
| New API endpoint added | Add to CLAUDE.md API section |
|
|
| Infrastructure change (port, host, service) | Update CONTEXT.md |
|
|
| Architecture decision made | Add to `docs/decisions/` or SESSION.md |
|
|
| New dependency added | Update README installation instructions |
|
|
|
|
## When to Update
|
|
|
|
- **Immediately** after the change, not at end of session
|
|
- Before committing the code change (so docs and code ship together)
|
|
- If you realize docs are stale during a session, fix them as you go
|
|
|
|
## What NOT to Put in CLAUDE.md
|
|
|
|
CLAUDE.md is loaded every session. Keep it lean:
|
|
- No session transcripts or conversation history
|
|
- No temporary debugging notes
|
|
- No duplicate information already in README
|
|
- No information that changes every session (put that in SESSION.md)
|
|
|
|
## Living Documents
|
|
|
|
Three files form the continuity chain across sessions. Keep all three current:
|
|
|
|
| File | Purpose | Update when... |
|
|
|------|---------|----------------|
|
|
| CLAUDE.md | Project state, architecture, tools | Components, tools, or architecture change |
|
|
| SESSION.md | Accumulated AI memory, decisions | Durable facts or decisions are discovered |
|
|
| CONTEXT.md | Static infrastructure facts | Infrastructure changes (ports, hosts, services) |
|
|
|
|
If you build a new tool and don't document it in CLAUDE.md, the next session won't know it exists.
|