docs-updater | Skill Performance & Reviews | TopRankSkills

TopRank Skills

Home / Skills / tools / docs-updater

docs-updater

maintained by anton-abyzov

star 28 account_tree 3 verified_user MIT License
bolt View GitHub

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:

**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

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!

Skill Details

GitHub Stars 28
GitHub Forks 3
Created Jan 2026
Last Updated 5个月前
tools tools productivity tools

Related Skills

planning-with-files
chevron_right
agent-browser
chevron_right
building-agents
chevron_right
notebooklm
chevron_right
google-cloud
chevron_right

Build your own?

Join 12,000+ developers contributing to the Claude ecosystem.