document
Use this skill after verification passes and the user approves the result. Updates feature docs, user guides, task retrospectives, LEARNINGS.md, and durable project instructions when the completed task changes reusable workflow knowledge.
How do I install this agent skill?
npx skills add https://github.com/eljun/claude-workflow-skills --skill documentIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The 'document' skill manages project documentation by reading task reports and file diffs. While it is useful for repository maintenance, it processes external data without sanitization, creating a potential surface for indirect prompt injection. It has no network access or administrative privileges.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
document - Documentation Stage
Invariants
- Run only after verification passed and the user approved the task.
- Base documentation on the task document, test report, and actual changed files.
- Update
LEARNINGS.mdfor reusable lessons. - Update
AGENTS.mdonly for stable project-level instructions. - Ensure the task is in
ApprovedinTASKS.mdbefore handoff. If a prior stage missed the move, reconcile the row toApprovedhere and re-read the tracker to confirm.
Runtime adapters may expose this stage as a slash command, menu action, or natural-language skill invocation. The portable stage name is document.
Workflow
- Read
AGENTS.md. - Resolve the task ID.
- Read the task document and test report.
- Review
git diff --name-onlyto identify actual changed files. - Create or update feature documentation in
docs/features/when developer-facing documentation is needed. - Create or update user guides in
docs/guides/when user-facing behavior changed. - Write a retrospective in
docs/learnings/{ID}-{task-name}.md. - Append reusable lessons to
LEARNINGS.mdwithout duplicating existing entries. - Update
AGENTS.mdonly if the task established durable project-level behavior. - Move the task to
ApprovedinTASKS.md(no-op iftestalready moved it; reconcile from any earlier section if not). - Re-read
TASKS.mdand verify the task row is inApprovedand absent fromPlanned,In Progress, orTesting. If the row is not in the expected section, the move was missed — perform the edit now before handoff.
Documentation Triggers
| Change | Documentation |
|---|---|
| New user-facing feature | Feature doc and user guide |
| Bug fix with user-visible behavior | Troubleshooting or guide update |
| API or CLI behavior | Developer docs or reference notes |
| New durable project convention | AGENTS.md |
| Reusable lesson or gotcha | LEARNINGS.md |
| Test setup learning | LEARNINGS.md and test report notes |
Retrospective Template
# Task {ID} Retrospective
## Plan Vs Reality
- {What matched or changed}
## Quality Gate Findings
- {What simplify caught}
## Verification Findings
- {What test found}
## Reusable Lessons
- {Actionable lesson}
Handoff
Documentation complete for task {ID}
Task status: Approved
Next stage: ship {ID}
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/eljun/claude-workflow-skills/document">View document on skillZs</a>