doc-sync

Audit and synchronize CLAUDE.md indexes with README.md across repositories or specified directories.

1|Updated Jan 12, 2026
One-click install
npx skills add https://github.com/akiselev/qt-llm-template --skill doc-sync-akiselev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/akiselev/qt-llm-template/tree/main/.claude/skills/doc-sync
Command: npx skills add https://github.com/akiselev/qt-llm-template --skill doc-sync-akiselev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Synchronizes the CLAUDE.md/README.md documentation hierarchy across a repository to prevent drift and ensure consistent context for LLM agents and humans.

Core Features & Use Cases

  • Phase-based workflow (Discovery, Audit, Migration, Update, Verification) to maintain documentation hygiene.
  • Automated detection of missing or outdated CLAUDE.md indexes and misplacements of architecture content.
  • Safe migration of architecture/designer notes from CLAUDE.md to README.md with verification and reporting.
  • Scope flexibility (repository-wide or directory-specific) to support onboarding, refactors, and audits.

Quick Start

Run the doc-sync skill to audit and synchronize the documentation hierarchy in the repository.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I synchronize CLAUDE.md and README.md documentation to prevent drift?

To synchronize CLAUDE.md and README.md documentation and prevent drift, run a phase-based workflow that detects outdated indexes, migrates misplaced architectural content to README.md, and updates index tables. This ensures consistent repository context for both LLM agents and humans.

What is documentation drift detection for repository indexes?

Documentation drift detection identifies misplacements where architectural content incorrectly resides in CLAUDE.md instead of README.md, and flags missing or outdated table-based indexes. It audits the hierarchy to guarantee LLM agents receive accurate, intended architectural knowledge.

Can I audit documentation hierarchy for specific directories instead of the whole repository?

Yes, you can audit documentation hierarchy for specific directories instead of the whole repository. The synchronization process supports scope flexibility, allowing targeted discovery, drift detection, and index updates tailored to directory-specific onboarding or refactoring efforts.

How do I migrate architectural content from CLAUDE.md to README.md safely?

To migrate architectural content from CLAUDE.md to README.md safely, the workflow moves designer notes during its migration phase, then applies a verification step. It reports the changes to ensure README.md contains the intended knowledge without data loss.

What format does CLAUDE.md require for documentation synchronization?

CLAUDE.md requires a strict table-based format for documentation synchronization. The process imposes this structure and validates that targeted directories have up-to-date indexes matching the table format before completing its verification phase.

Why does CLAUDE.md documentation synchronization fail during index updates?

CLAUDE.md documentation synchronization may fail during index updates if the existing CLAUDE.md format does not use the required table-based structure, or if targeted directories lack the necessary up-to-date indexes needed to pass the final verification phase.