Update Documentation in AI
From the AI Workflow cheat sheet · Feature Completion & Review · verified Jul 2026
Update Documentation
Keep documentation current with changes
markdown
DOCUMENTATION UPDATES:
Update README.md:
- How to set up new features
- Required environment variables
- How to run the app
- New dependencies or requirements
Update API documentation:
- New endpoints or changes to existing
- Request/response formats
- Authentication requirements
Update PLAN.md:
- Mark feature as complete
- Document decisions made
- Note any deviations from original plan
Update claude.md:
- New architectural patterns
- New coding standards adopted
- Libraries or approaches to use/avoid
Add code comments:
- Only for complex logic
- Explain WHY, not WHAT
- Keep them concise💡 Update docs while context is fresh in your mind
⚡ Good docs save time for future you and teammates
📌 Document architectural decisions and reasoning
🎯 Comments should explain why, code explains what
documentation