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-mixseek-plus-docs-sync3description: docs-sync4---56# docs-sync78Synchronizes documentation with implementation after `/speckit.implement` completes.910## Purpose1112This skill automatically updates documentation to reflect the implemented features. It:1314- **Updates README.md**: Adds/updates usage section with implementation details15- **Updates CHANGELOG.md**: Adds entries for new features and changes16- **Updates API docs**: Synchronizes API documentation with contracts17- **Preserves user content**: Content outside speckit markers is never modified1819## Marker System2021docs-sync uses HTML comment markers to delineate auto-generated sections:2223```markdown24<!-- speckit:start:section-name -->25Auto-generated content here26<!-- speckit:end:section-name -->27```2829Content outside these markers is preserved exactly as-is.3031## Output3233The skill outputs a **DocsSyncResult** showing:3435- Files created, updated, or unchanged36- Sections modified within each file37- Diff summary (lines added/removed/changed)38- Any errors encountered3940## Usage4142This skill runs automatically after `/speckit.implement`. You can also run it manually:4344```bash45npx skills run docs-sync46```4748## Exit Codes4950| Code | Status | Meaning |51|------|--------|---------|52| 0 | Success | All updates successful |53| 1 | Partial | Some updates failed |54| 3 | Error | Required files missing |5556## Sections Updated5758### README.md5960| Section | Marker | Content Source |61|---------|--------|----------------|62| Usage | `<!-- speckit:start:usage -->` | spec.md user stories |63| Installation | `<!-- speckit:start:installation -->` | plan.md dependencies |64| Features | `<!-- speckit:start:features -->` | spec.md functional requirements |6566### CHANGELOG.md6768| Section | Marker | Content Source |69|---------|--------|----------------|70| Unreleased | `<!-- speckit:start:unreleased -->` | tasks.md completed tasks |7172## Preservation Rules73741. Content before the first marker is always preserved752. Content after the last marker is always preserved763. Content between different marker pairs is always preserved774. Only content within matching marker pairs is updated785. If no markers exist, content is appended with new markers7980## Error Handling8182- **Missing markers**: Creates new markers and adds content83- **Malformed markers**: Reports error, skips that section84- **File permissions**: Reports error, continues with other files85- **Missing source files**: Reports which sources are unavailable8687---88> Converted and distributed by [TomeVault](https://tomevault.io/claim/drillan) — claim your Tome and manage your conversions.89<!-- tomevault:4.0:skill_md:2026-04-13 -->
Run npx skillmds@latest add tomevault-io/drillan-mixseek-plus-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. 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