Loading...
Loading...
Update project documentation after feature approval. Creates/updates feature docs and user guides. Use after /test passes and user approves. Supports task IDs for easier invocation.
npx skill4agent add webriq/claude-skills documentModel: haiku (templated documentation work)
| Flag | Short | Description |
|---|---|---|
| | Show available commands and options |
| | Show workflow skills version |
-h--help/document - Documentation Agent
Usage:
/document {ID} Update docs for a task
/document -h, --help Show this help message
/document -v, --version Show version
Arguments:
{ID} Task ID (number) or task filename (e.g., 001-auth-jwt)
Creates/Updates:
- docs/features/{feature}.md Technical documentation
- docs/guides/{feature}.md User guides (if user-facing)
- CLAUDE.md Project patterns (if needed)
Examples:
/document 1 # Document task #1
/document 001-auth-jwt # Using task filename
Next: /ship {ID}-v--versionWorkflow Skills v1.4.1
https://github.com/eljun/claude-skills/document {ID}/test/document 1/document 001-dashboard-redesign{ID}123001002001-dashboard-redesign/document {ID}
↓
1. Resolve task ID → find task document
2. Read task document for context
3. Check Automation field (manual | auto)
4. Read test report for verification
5. Update/create feature documentation
6. Update/create user guide (if user-facing)
7. Update CLAUDE.md files if needed
8. Move task to "Approved" in TASKS.md
↓
┌─── Automation Mode? ───┐
│ │
▼ Manual ▼ Auto
Notify user Invoke /ship {ID}
Ready for /shipAutomation: autoDocumentation complete: #{ID} - {Task Title}
Updated files:
- docs/features/{feature}.md
- docs/guides/{feature}.md
[AUTO] Spawning /ship with haiku model...Task({ subagent_type: "general-purpose", model: "haiku", prompt: "/ship {ID}" })docs/task/{ID}-{task-name}.md - Implementation details
docs/testing/{ID}-{task-name}.md - Test results & verification/task/implement/test| Change Type | Documentation Needed |
|---|---|
| New feature | Feature doc + User guide |
| Enhancement | Update existing docs |
| Bug fix | Update troubleshooting sections |
| API change | Update API reference |
docs/features/{FEATURE}.mddocs/guides/{feature}.md/CLAUDE.md# Feature: {Feature Name}
> **Status:** PRODUCTION
> **Last Updated:** {Date}
## Overview
{Brief 2-3 sentence description}
---
## User Journey
### For Customers
1. Step 1
2. Step 2
### For Business Owners
1. Step 1
2. Step 2
---
## Architecture
### File Structure
{Accurate file tree - VERIFY paths exist}
### Database Schema
{SQL with comments, if applicable}
### API Endpoints
| Method | Endpoint | Description |
|--------|----------|-------------|
---
## Implementation Details
### Key Components
| Component | Location | Purpose |
|-----------|----------|---------|
### Technical Notes
- Important detail 1
- Important detail 2
---
## Related Features
- [Link to related feature]# {Feature Name} Guide
> {Brief intro sentence}
## Quick Start
{1-2 paragraph overview}
---
## For Customers
### How to {Primary Action}
1. Step with context
2. Step with context
### Tips
- Tip 1
- Tip 2
---
## For Business Owners
### How to {Admin Action}
1. Step with context
### Settings
| Setting | Location | What it does |
|---------|----------|--------------|
---
## FAQ
**Q: Question?**
A: Answer.
---
## Troubleshooting
**Issue:** Description
**Solution:** How to fix
---
## Related Guides
- [Link]## Approved
| ID | Task | Task Doc | Feature Doc | Test Report | Approved |
|----|------|----------|-------------|-------------|----------|
| 1 | Quick Actions Redesign | [001-quick-actions.md](docs/task/001-quick-actions.md) | [feature](docs/features/...) | [001-quick-actions.md](docs/testing/001-quick-actions.md) | Jan 25 || Remove | Why |
|---|---|
| Development logs | Move to changelogs |
| Before/after comparisons | Only document current state |
| "Lessons learned" | Dev notes, not docs |
| Speculative future phases | Keep minimal |
| Full component code | Code lives in codebase |
Automation: autoDocumentation updated for: #{ID} - {Task Title}
Updated files:
- docs/features/{feature}.md (created/updated)
- docs/guides/{feature}.md (created/updated)
- CLAUDE.md (if updated)
Task moved to "Approved" in TASKS.md
Next Steps:
/ship {ID} # e.g., /ship 1
/ship {ID}-{task-name} # e.g., /ship 001-auth-jwtDocumentation updated for: #{ID} - {Task Title}
Updated files:
- docs/features/{feature}.md (created/updated)
- docs/guides/{feature}.md (created/updated)
- CLAUDE.md (if updated)
Task moved to "Approved" in TASKS.md
[AUTO] Spawning /ship with haiku model...Task({ subagent_type: "general-purpose", model: "haiku", prompt: "/ship {ID}" })| Skill | When to Use |
|---|---|
| If issues found during doc review |
| After documentation complete |
| Plugin | Install From | When to Invoke |
|---|---|---|
| vercel-labs/agent-skills | Reference React patterns for docs |
| supabase/agent-skills | Reference database patterns for docs |