home / skills / anton-abyzov / specweave / docs-updater

docs-updater skill

safe

/plugins/specweave/skills/docs-updater

This skill automatically syncs implementation progress to living documentation, updating drafts to complete, linking increments, and aligning specs with code.

This is most likely a fork of the sw-docs-updater skill from openclaw

npx playbooks add skill anton-abyzov/specweave --skill docs-updater

Review the files below or copy the command above to add this skill to your agents.

Files (3)

SKILL.md

2.0 KB

---
name: docs-updater
description: Living documentation updater that syncs implementation progress to product docs. Use when updating docs after task completion, changing DRAFT status to published, or ensuring documentation reflects current implementation state.
---

# 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

Overview

This skill keeps product documentation in sync with implementation by updating living docs under .specweave/docs/. It reads task signals and code to convert draft doc sections into accurate, published documentation. Use it to ensure docs reflect completed work and maintain links between increments and docs.

How this skill works

The updater scans tasks.md for documentation entries and reads the implementation code to extract concrete examples, endpoints, and configuration. It writes changes into .specweave/docs/**/*.md, adapts to existing folder structures, and flips status markers from [DRAFT] to [COMPLETE]. It also verifies and preserves relative links between increments and documentation pages.

When to use it

After completing feature or bugfix tasks that include documentation items
When tasks.md lists .specweave/docs/*.md files as DRAFT
To sync docs after closing an increment or release
When a stakeholder requests "update documentation" or "sync docs"
Before publishing docs to ensure accuracy

Best practices

Run the updater after implementation is finished, not mid-development
Keep examples minimal and directly tied to code paths used in production
Verify relative links and cross-references after the update
Limit scope to documented user-facing behavior to avoid over-documenting
Use task completion hooks to trigger updates for consistent workflow

Example use cases

A payment feature implementation finishes; updater injects real endpoints and example requests into payment.md and marks it COMPLETE
API changes are merged; updater reads routes and updates api docs to match current endpoints
A release manager closes an increment and runs updater to reflect final behavior across module docs
Automated task hooks call the updater after CI passes to keep docs current without manual edits

FAQ

Which files does the updater modify?

It updates files under .specweave/docs/**/*.md referenced in tasks.md or discovered via increment links.

How does it decide what to write into docs?

It reads task requirements and scans implementation code to extract real examples, endpoints, and configuration, then formats content to match existing doc structure.