How do I install the Docs Sync skill?

Run npx skillmds@latest add drillan/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.

Is Docs Sync safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Docs Sync?

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.

Is Docs Sync free to use?

Yes. Installing skills from SkillMD is free. This skill is licensed under MIT.

Who published Docs Sync?

drillan (@drillan) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Docs Sync by drillan — Agent Skill

Name: Docs Sync
Author: drillan

Docs Sync

Synchronizes documentation (README.md, CHANGELOG.md, API docs) with implementation. Preserves user content outside speckit markers. Updates are non-destructive and clearly delineated. Always run after /speckit.implement completes.

drillan 6aa6765 2 files · 22.9 KB Updated Sep 17, 2026

File contents

docs-sync

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

---name: docs-syncdescription: Synchronizes documentation (README.md, CHANGELOG.md, API docs) with implementation. Preserves user content outside speckit markers. Updates are non-destructive and clearly delineated. Always run after /speckit.implement completes.license: MIT---# docs-syncSynchronizes documentation with implementation after `/speckit.implement` completes.## PurposeThis 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 Systemdocs-sync uses HTML comment markers to delineate auto-generated sections:```markdownAuto-generated content here```Content outside these markers is preserved exactly as-is.## OutputThe skill outputs a **DocsSyncResult** showing:- Files created, updated, or unchanged- Sections modified within each file- Diff summary (lines added/removed/changed)- Any errors encountered## UsageThis skill runs automatically after `/speckit.implement`. You can also run it manually:```bashnpx 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 | `` | spec.md user stories || Installation | `` | plan.md dependencies || Features | `` | spec.md functional requirements |### CHANGELOG.md| Section | Marker | Content Source ||---------|--------|----------------|| Unreleased | `` | tasks.md completed tasks |## Preservation Rules1. Content before the first marker is always preserved2. Content after the last marker is always preserved3. Content between different marker pairs is always preserved4. Only content within matching marker pairs is updated5. 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

Frequently asked questions