docs-updater

What This Skill Does

The docs-updater skill acts as a specialized documentation agent for the OpenClaw ecosystem, ensuring that your project documentation evolves in lockstep with your source code. By analyzing your tasks.md file and scanning the actual implementation files within your repository, it identifies discrepancies between what you planned to build and what you have actually coded. The agent automatically modifies files located in .specweave/docs/, injects relevant code snippets, generates documentation for new API endpoints, and handles the state transition of documentation sections from [DRAFT] to [COMPLETE]. This eliminates the common developer pain point of "stale documentation" by formalizing the update process as a mandatory step in the project lifecycle.

Installation

To integrate this skill into your OpenClaw environment, execute the following command in your terminal:

clawhub install openclaw/skills/skills/anton-abyzov/sw-docs-updater

Ensure that your project root contains a valid .specweave directory, as the skill relies on this structure for locating documentation targets and maintaining consistency across the project architecture.

Use Cases

• Post-Sprint Cleanup: After a series of feature increments, use this skill to reconcile your API specs and user guides with the final code state.
• Automated Documentation Status Tracking: Automatically flag pending documentation updates in your tasks.md and have the agent resolve them systematically.
• Consistency Maintenance: Ensuring that code examples within documentation are reflective of the actual current implementation logic, preventing user errors caused by outdated docs.
• Team Handoffs: Preparing a repository for external contributors or new team members by ensuring all docs are marked [COMPLETE] and provide accurate context.

Example Prompts

1. "Check the tasks.md file and update all [DRAFT] documentation sections based on the recent changes made to the payment module."
2. "I've just finished the authentication refactor. Please sync the docs in .specweave/docs/api/ to reflect the new header-based tokens."
3. "Run the docs-updater to ensure the project documentation is fully up to date and mark all finished tasks as complete."

Tips & Limitations

• Timing: Always invoke this skill after you have finalized your code. Running it mid-implementation may result in incomplete documentation based on unfinished logic.
• Verification: While the agent is highly accurate, it is best practice to perform a quick review of the generated documentation, especially when handling complex code snippets or architectural diagrams.
• Structure: Maintain a clean .specweave/docs/ hierarchy; the skill is most effective when documentation is organized into clear features or modules, as it allows the agent to map implementation changes to specific files with higher precision.