Back to Skills

docs-updater

verified

Updates living documentation during implementation. Syncs task completion to docs, changes [DRAFT] to [COMPLETE], maintains bidirectional links. Activates for update docs, sync documentation, mark complete, documentation updates, living docs sync.

View on GitHub

Marketplace

specweave

anton-abyzov/specweave

Plugin

sw

development

Repository

anton-abyzov/specweave
27stars

plugins/specweave/skills/docs-updater/SKILL.md

Last Verified

January 25, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/anton-abyzov/specweave/blob/main/plugins/specweave/skills/docs-updater/SKILL.md -a claude-code --skill docs-updater

Installation paths:

Claude
.claude/skills/docs-updater/
Powered by add-skill CLI

Instructions

# 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

1. **Reads task requirements** - Understands what was implemented from tasks.md
2. **Updates living docs** - Modifies `.specweave/docs/` files with actual implementation
3. **Status tracking** - Changes `[DRAFT]` � `[COMPLETE]` on doc sections
4. **Bidirectional links** - Maintains links between docs and increments
5. **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:**
```markdown
**Documentation Updates**:
- [ ] .specweave/docs/features/payment.md [DRAFT]
- [ ] .specweave/docs/api/payments.md [DRAFT]
```

**docs-updater does:**
1. Reads payment implementation code
2. Updates `payment.md` with actual code examples
3. Updates API docs with real endpoints discovered in code
4. 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

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
1751 chars