document_skill

Overview

This skill updates project documentation after a feature is approved and tests pass. It creates or updates technical feature docs, user guides, and project pattern notes, and moves the task to Approved. It accepts task IDs or task filenames for easy invocation and can optionally trigger the shipping workflow in auto mode.

How this skill works

Provide a task ID or filename to resolve the corresponding task and read the task and test documents for context. The agent verifies the Automation field, checks the test report, generates or updates docs in docs/features and docs/guides (and CLAUDE.md when needed), and marks the task as Approved in TASKS.md. If Automation is set to auto, it will spawn the ship agent automatically.

When to use it

• After /test returns PASS and the user approves the implementation
• When a new feature or enhancement is ready to be documented
• To update user-facing guides after UI or workflow changes
• To add troubleshooting notes or update API references after changes
• When you want the agent to optionally trigger /ship in auto mode

Best practices

• Only read docs/task/{ID}-{name}.md and docs/testing/{ID}-{name}.md for context—avoid broad codebase scans
• Verify file paths and API/schema snippets match production before committing
• Keep feature docs technical and developer-focused; keep user guides concise and step-driven
• Set Status to PRODUCTION and update Last Updated date on feature docs
• Follow the provided templates and keep feature docs under 400 lines and guides under 200 lines

Example use cases

• /document 1 after tests pass to create feature and user docs for task #1
• /document 001-auth-jwt to update API reference and user guide for an auth change
• Run /document {ID} to add troubleshooting steps after a bug fix
• Use when Automation: auto is set to automatically spawn /ship after docs are ready
• Update CLAUDE.md with new Do/Do Not patterns discovered during implementation