An automated workflow that aligns project documentation, changelogs, and task lists with actual code changes to ensure delivery consistency.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install openclaw-doc-sync
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install openclaw-doc-sync using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is ClawLite Doc Sync?
ClawLite Doc Sync is a specialized post-release synchronization tool designed to ensure your project's narrative stays in lockstep with its implementation. By analyzing git diffs and commit histories, this skill automatically identifies factual gaps in your README, ARCHITECTURE, and CONTRIBUTING files. It is an essential component of the Openclaw Skills ecosystem for developers who want to maintain high-quality documentation without the manual overhead.
The skill operates with a sophisticated balance of automation and human oversight. It handles clear factual updates—such as path changes, new command additions, and project structure modifications—autonomously. However, it intelligently pauses to ask for user input when dealing with subjective design philosophies, security models, or major narrative shifts, ensuring that the AI never misrepresents your project's core intent.
ClawLite Doc Sync Use Cases
- Aligning README and ARCHITECTURE documents with code changes before a Pull Request is merged.
- Transforming technical commit messages into user-friendly CHANGELOG entries that highlight value.
- Automatically moving finished items in TODOS.md to a completed section based on recent commits.
- Performing cross-document consistency checks to ensure version numbers match across all markdown files.
- Auditing documentation discoverability to ensure all .md files are linked from primary entry points.
How ClawLite Doc Sync Works
- Analyzes the git diff and log between the current feature branch and the base branch to categorize changes as new features, behavioral updates, or infrastructure shifts.
- Scans the project directory to locate all relevant markdown files and cross-references them with the identified code changes.
- Applies factual auto-updates to tables, lists, and project trees while preserving the existing writing style.
- Conducts a tone audit of the CHANGELOG, optimizing entries to focus on user capabilities rather than implementation details.
- Performs a cross-document audit to resolve contradictions and ensure all files are reachable from the README or CLAUDE.md.
- Prompts the user for a semantic version bump if the scope of changes warrants a new release tag.
- Stages the documentation changes and creates a structured commit to finalize the sync.
ClawLite Doc Sync Setup
To integrate this workflow into your environment, ensure you are working within a git-initialized project. This skill is designed to run from a feature branch before merging into your main production branch. You can initiate the process within your Openclaw Skills enabled editor using the following command:
/doc-sync
Ensure that your environment has access to standard git CLI tools for diff and log analysis.
ClawLite Doc Sync Data Schema & Taxonomy
ClawLite Doc Sync operates on a hierarchy of documentation files, treating each with a specific level of automation authority:
| File Type | Primary Focus | Update Logic |
|---|---|---|
| README.md | Capabilities & Setup | Factual auto-sync; narrative remains manual |
| ARCHITECTURE.md | System Design | Conservative; only updates via clear diff evidence |
| CHANGELOG.md | User Value | Tone optimization; never overwrites existing entries |
| TODOS.md | Task Management | Auto-moves completed tasks to versioned headers |
| VERSION | Release Tracking | Interactive prompts for PATCH or MINOR bumps |
All modifications are performed using precise string matching to maintain the original file formatting and metadata taxonomy.
ClawLite Doc Sync Advanced Features
- User-Centric CHANGELOG Polishing: Converts raw commit logs into a 'Sales Test' passed format that highlights what users can now do.
- Smart TODO Migration: Detects completed tasks in the code and automatically archives them in TODOS.md with the current version and date.
- Documentation Discoverability Audit: Identifies 'orphaned' markdown files that aren't linked from the main project entry points.
- Context-Aware Versioning: Suggests version bumps based on whether the diff contains breaking changes, new features, or just documentation fixes.
- Multi-Agent Consistency: Ensures that all documents updated by different Openclaw Skills stay harmonized in terms of terminology and facts.
SKILL.md
Loading
Related Openclaw Skills
NAS Download Manager
A powerful bash-based utility for managing qBittorrent downloads on Feiniu NAS servers using Openclaw Skills.
Openclaw Design Consult
A senior-level product design system consultant that proactively clarifies requirements and generates comprehensive design documentation.
Tax Plain English
A high-performance AI agent skill that translates complex US federal tax regulations into clear, conversational, and actionable guidance for everyday financial decisions.
Openclaw CEO Review Skill
A high-level strategic auditor that reviews technical plans from a CEO's perspective to ensure excellence, risk mitigation, and scope alignment.
Xiaodi Financial Team
A sophisticated multi-agent financial analysis system providing professional-grade stock research, portfolio diagnostics, and asset allocation strategies.
Openclaw Office Hours
A strategic product consultation skill that reframes problems and validates user demand using YC Office Hours methodology before any code is written.
Featured*
