doc-auto-sync

Detect code changes and update affected project documentation files.

Updated Jan 8, 2026
One-click install
npx skills add https://github.com/munlucky/claude-settings --skill doc-auto-sync-munlucky
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-auto-sync
Source: https://github.com/munlucky/claude-settings/tree/main/.claude/skills/doc-auto-sync
Command: npx skills add https://github.com/munlucky/claude-settings --skill doc-auto-sync-munlucky

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detects code changes and updates related documentation across PROJECT.md, README, CHANGELOG, and generated docs, helping keep project docs aligned with code.

Core Features & Use Cases

  • Automatically map code changes to affected docs and bootstrap the documentation structure.
  • Update PROJECT.md sections (api-data-patterns, stack, environment-variables, etc.) and regenerate docs as needed.
  • Bootstrap new projects by creating essential docs when missing and adding auto-synced sections.
  • Include freshness checks to surface stale docs and pre-flight validation before changes are merged.

Quick Start

Run the doc-auto-sync skill after implementing changes to automatically refresh affected docs.

Frequently Asked Questions about doc-auto-sync

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

FAQPage Schema
How do I automatically sync documentation when my code changes?

Automatically sync documentation by detecting code changes and mapping them to affected project docs. This updates PROJECT.md, README, CHANGELOG, and generated docs to keep everything aligned with your codebase.

What is the best way to bootstrap missing project documentation?

Bootstrap missing project documentation by running auto-sync to create essential files like README and PROJECT.md. It adds auto-synced sections and establishes doc-mapping rules for new projects lacking structure.

How do I check if my project documentation is stale or outdated?

Check for stale documentation using freshness checks that surface outdated docs. Pre-flight validation runs before merging changes to identify which PROJECT.md sections or generated docs need updating.

Can I automatically update PROJECT.md sections like environment variables and stack?

Yes, you can automatically update PROJECT.md sections including api-data-patterns, stack, and environment-variables. The auto-sync maps code changes to these specific sections and regenerates docs as needed.

Does doc-auto-sync work with generated docs and CHANGELOG files?

Yes, doc-auto-sync works with generated docs and CHANGELOG files alongside README and PROJECT.md. It applies doc-mapping rules across all these files to detect code changes and synchronize affected documentation sections.

When should I run documentation auto-synchronization during my development workflow?

Run documentation auto-synchronization after implementing code changes to refresh affected docs. This ensures PROJECT.md, CHANGELOG, and generated documentation stay aligned before pre-flight validation checks for stale content.