skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
eljun/claude-workflow-skills92 installs

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 document
view source ↗

Is 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.md for reusable lessons.
  • Update AGENTS.md only for stable project-level instructions.
  • Ensure the task is in Approved in TASKS.md before handoff. If a prior stage missed the move, reconcile the row to Approved here 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

  1. Read AGENTS.md.
  2. Resolve the task ID.
  3. Read the task document and test report.
  4. Review git diff --name-only to identify actual changed files.
  5. Create or update feature documentation in docs/features/ when developer-facing documentation is needed.
  6. Create or update user guides in docs/guides/ when user-facing behavior changed.
  7. Write a retrospective in docs/learnings/{ID}-{task-name}.md.
  8. Append reusable lessons to LEARNINGS.md without duplicating existing entries.
  9. Update AGENTS.md only if the task established durable project-level behavior.
  10. Move the task to Approved in TASKS.md (no-op if test already moved it; reconcile from any earlier section if not).
  11. Re-read TASKS.md and verify the task row is in Approved and absent from Planned, In Progress, or Testing. If the row is not in the expected section, the move was missed — perform the edit now before handoff.

Documentation Triggers

ChangeDocumentation
New user-facing featureFeature doc and user guide
Bug fix with user-visible behaviorTroubleshooting or guide update
API or CLI behaviorDeveloper docs or reference notes
New durable project conventionAGENTS.md
Reusable lesson or gotchaLEARNINGS.md
Test setup learningLEARNINGS.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}

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>