Synchronizes documentation with implementation after /speckit.implement completes.
Purpose
This skill automatically updates documentation to reflect the implemented features. It:
Updates README.md: Adds/updates usage section with implementation details
Updates CHANGELOG.md: Adds entries for new features and changes
Updates API docs: Synchronizes API documentation with contracts
Preserves user content: Content outside speckit markers is never modified
Marker System
docs-sync uses HTML comment markers to delineate auto-generated sections:
<!-- speckit:start:section-name -->
Auto-generated content here
<!-- speckit:end:section-name -->
Content outside these markers is preserved exactly as-is.
Output
The skill outputs a DocsSyncResult showing:
Files created, updated, or unchanged
Sections modified within each file
Diff summary (lines added/removed/changed)
Any errors encountered
Usage
This skill runs automatically after /speckit.implement. You can also run it manually:
npx skills run docs-sync
Exit Codes
Code
Status
Meaning
0
Success
All updates successful
1
Partial
Some updates failed
3
Error
Required files missing
Sections Updated
README.md
Section
Marker
Content Source
Usage
<!-- speckit:start:usage -->
spec.md user stories
Installation
<!-- speckit:start:installation -->
plan.md dependencies
Features
<!-- speckit:start:features -->
spec.md functional requirements
CHANGELOG.md
Section
Marker
Content Source
Unreleased
<!-- speckit:start:unreleased -->
tasks.md completed tasks
Preservation Rules
Content before the first marker is always preserved
Content after the last marker is always preserved
Content between different marker pairs is always preserved
Only content within matching marker pairs is updated
If no markers exist, content is appended with new markers
Error Handling
Missing markers: Creates new markers and adds content
Malformed markers: Reports error, skips that section
File permissions: Reports error, continues with other files
Missing source files: Reports which sources are unavailable
Converted and distributed by TomeVault — claim your Tome and manage your conversions.
1---2name: drillan-speckit-gates-docs-sync3description: > Use when this capability is needed.4metadata:5 author: drillan6---78# docs-sync910Synchronizes documentation with implementation after `/speckit.implement` completes.1112## Purpose1314This skill automatically updates documentation to reflect the implemented features. It:1516- **Updates README.md**: Adds/updates usage section with implementation details17- **Updates CHANGELOG.md**: Adds entries for new features and changes18- **Updates API docs**: Synchronizes API documentation with contracts19- **Preserves user content**: Content outside speckit markers is never modified2021## Marker System2223docs-sync uses HTML comment markers to delineate auto-generated sections:2425```markdown26<!-- speckit:start:section-name -->27Auto-generated content here28<!-- speckit:end:section-name -->29```3031Content outside these markers is preserved exactly as-is.3233## Output3435The skill outputs a **DocsSyncResult** showing:3637- Files created, updated, or unchanged38- Sections modified within each file39- Diff summary (lines added/removed/changed)40- Any errors encountered4142## Usage4344This skill runs automatically after `/speckit.implement`. You can also run it manually:4546```bash47npx skills run docs-sync48```4950## Exit Codes5152| Code | Status | Meaning |53|------|--------|---------|54| 0 | Success | All updates successful |55| 1 | Partial | Some updates failed |56| 3 | Error | Required files missing |5758## Sections Updated5960### README.md6162| Section | Marker | Content Source |63|---------|--------|----------------|64| Usage | `<!-- speckit:start:usage -->` | spec.md user stories |65| Installation | `<!-- speckit:start:installation -->` | plan.md dependencies |66| Features | `<!-- speckit:start:features -->` | spec.md functional requirements |6768### CHANGELOG.md6970| Section | Marker | Content Source |71|---------|--------|----------------|72| Unreleased | `<!-- speckit:start:unreleased -->` | tasks.md completed tasks |7374## Preservation Rules75761. Content before the first marker is always preserved772. Content after the last marker is always preserved783. Content between different marker pairs is always preserved794. Only content within matching marker pairs is updated805. If no markers exist, content is appended with new markers8182## Error Handling8384- **Missing markers**: Creates new markers and adds content85- **Malformed markers**: Reports error, skips that section86- **File permissions**: Reports error, continues with other files87- **Missing source files**: Reports which sources are unavailable8889---90> Converted and distributed by [TomeVault](https://tomevault.io/claim/drillan) — claim your Tome and manage your conversions.91<!-- tomevault:4.0:skill_md:2026-04-13 -->
Run npx skillmds@latest add tomevault-io/drillan-speckit-gates-docs-sync in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
docs-sync It is listed under Coding & Dev Tools on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: makes network calls. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.
tomevault-io