doc-sync

Sync project documentation with the codebase and enforce cross-linking rules.

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/esp1/claude-config --skill doc-sync-esp1
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/esp1/claude-config/tree/main/dot.claude/skills/doc-sync
Command: npx skills add https://github.com/esp1/claude-config --skill doc-sync-esp1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the actual codebase, creating divergent indices, broken links, and outdated requirements. This Skill automates the alignment of project documentation by syncing the documentation index, functional requirements, and technical docs, and by enforcing a minimal, consistent structure across the repository.

Core Features & Use Cases

  • Syncs top-level documentation structure with the codebase to prevent drift.
  • Ensures functional specs link to the corresponding technical docs and vice versa.
  • Detects and prevents duplication between README, docs/index.md, and category indexes, guiding proper placement.
  • Triggered as part of the development workflow after successful code changes to keep documentation in sync and up-to-date.

Quick Start

Run doc-sync after making code changes to refresh the documentation index and ensure cross-references stay accurate.

Frequently Asked Questions about doc-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation aligned with code changes automatically?

To keep documentation aligned with code changes automatically, apply a sync workflow after successful updates to refresh the documentation index and ensure cross-references stay accurate.

Why does documentation drift from the current codebase?

Documentation drifts from the current codebase when updates are applied without syncing the documentation index, functional requirements, and technical docs, creating divergent structures and broken cross-links.

When should I run a documentation sync workflow?

You should run a documentation sync workflow after successful code changes, new feature implementations, or documentation reorganizations to keep functional and technical docs in sync.

How do I prevent duplication between README and category indexes?

Prevent duplication between README and category indexes by enforcing placement rules that guide proper document structuring across the repository during the documentation sync process.

Does doc-sync enforce frontmatter presence and cross-linking?

Yes, doc-sync enforces frontmatter presence and cross-linking between functional specs and technical docs to maintain a minimal, consistent structure across the project repository.