sw:docs-updater
Documentation Updater
Updates product documentation (.specweave/docs/) based on implementation progress.
When to Use
- Task specifies documentation updates in tasks.md
- Feature implementation is complete
- User says "update documentation" or "sync docs"
- After closing increment to ensure docs reflect reality
What It Does
- Reads task requirements - Understands what was implemented from tasks.md
- Updates living docs - Modifies
.specweave/docs/files with actual implementation - Status tracking - Changes
[DRAFT]�[COMPLETE]on doc sections - Bidirectional links - Maintains links between docs and increments
- Format adaptation - Matches existing doc structure (features/ or modules/)
Workflow
1. Read tasks.md � Find documentation tasks
2. Read implementation � Understand what changed
3. Update docs � Add real code examples, endpoints, configs
4. Mark complete � Change [DRAFT] to [COMPLETE]
5. Verify links � Ensure increment � doc references work
Example
tasks.md says:
**Documentation Updates**:
- [ ] .specweave/docs/features/payment.md [DRAFT]
- [ ] .specweave/docs/api/payments.md [DRAFT]
docs-updater does:
- Reads payment implementation code
- Updates
payment.mdwith actual code examples - Updates API docs with real endpoints discovered in code
- Changes status to
[COMPLETE]
Integration Points
- Called by: spec-generator, task completion hooks
- Updates:
.specweave/docs/**/*.md - Reads:
tasks.md, implementation code
Best Practices
- Run after completing feature tasks, not during
- Verify doc links are valid (use relative paths)
- Keep examples in sync with actual code
- Don't over-document - focus on what users need
Project-Specific Learnings
Before starting work, check for project-specific learnings:
# Check if skill memory exists for this skill
cat .specweave/skill-memories/docs-updater.md 2>/dev/null || echo "No project learnings yet"
Project learnings are automatically captured by the reflection system when corrections or patterns are identified during development. These learnings help you understand project-specific conventions and past decisions.
More from anton-abyzov/specweave
technical-writing
Technical writing expert for API documentation, README files, tutorials, changelog management, and developer documentation. Covers style guides, information architecture, versioning docs, OpenAPI/Swagger, and documentation-as-code. Activates for technical writing, API docs, README, changelog, tutorial writing, documentation, technical communication, style guide, OpenAPI, Swagger, developer docs.
45spec-driven-brainstorming
Spec-driven brainstorming and product discovery expert. Helps teams ideate features, break down epics, conduct story mapping sessions, prioritize using MoSCoW/RICE/Kano, and validate ideas with lean startup methods. Activates for brainstorming, product discovery, story mapping, feature ideation, prioritization, MoSCoW, RICE, Kano model, lean startup, MVP definition, product backlog, feature breakdown.
43kafka-architecture
Apache Kafka architecture expert for cluster design, capacity planning, and high availability. Use when designing Kafka clusters, choosing partition strategies, or sizing brokers for production workloads.
34docusaurus
Docusaurus 3.x documentation framework - MDX authoring, theming, versioning, i18n. Use for documentation sites or spec-weave.com.
29frontend
Expert frontend developer for React, Vue, Angular, and modern JavaScript/TypeScript. Use when creating components, implementing hooks, handling state management, or building responsive web interfaces. Covers React 18+ features, custom hooks, form handling, and accessibility best practices.
29reflect
Self-improving AI memory system that persists learnings across sessions in CLAUDE.md. Use when capturing corrections, remembering user preferences, or extracting patterns from successful implementations. Enables continual learning without starting from zero each conversation.
27