| name | 05-document |
| description | Document all changes, decisions, and usage instructions as the final workflow step |
Step 5: Documentation
Goal
Record everything that was done, decided, and changed so that future developers
can understand and maintain the work.
What You Need
- Analysis results: workflow-state/analysis-results.md
- Implementation plan: workflow-state/implementation-plan.md
- Implementation results: workflow-state/implementation-results.md
- Test results: workflow-state/test-results.md
- All modified files
Process
- Update inline code documentation (comments, JSDoc, docstrings)
- Update the README if necessary
- Update API documentation if applicable
- Create or update user guides if needed
- Document architectural decisions
- Update the changelog
- Write a summary of the entire workflow execution
Verification
Output
- Updated documentation files as appropriate
- Write workflow-state/workflow-summary.md containing:
- Overview of what was accomplished
- All files changed
- Key decisions made
- Tests added
- How to use the new functionality
- Future considerations
Workflow Complete
This is the final step. Review the workflow-summary.md and confirm all objectives are met.