docs-auto-sync

Automatically update repository documentation whenever code changes (add/edit/refactor) occur. Use when modifying source code, public APIs/contracts, rendering/interaction/data/compute logic, diagnostics, or build/release/CI flows so docs stay consistent without asking.

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

When & Why to Use This Skill

This Claude skill automates the synchronization of repository documentation with real-time code changes. By analyzing modifications in source code, public APIs, and system logic, it ensures that technical manuals, READMEs, and design notes remain accurate and up-to-date without manual intervention, effectively eliminating documentation debt and ensuring consistency across the development lifecycle.

Use Cases

  • API Contract Updates: Automatically revise public API documentation and versioning notes whenever interface definitions or endpoint contracts are modified.
  • Logic Refactoring: Synchronize internal technical design documents and data flow descriptions when core rendering, compute, or interaction logic is refactored.
  • CI/CD Pipeline Maintenance: Keep build, release, and deployment instructions current by automatically detecting changes in CI/CD flows or infrastructure-as-code files.
  • Architecture Consistency: Update cross-links and architectural references across multiple documentation files to reflect changes in repository structure or module boundaries.
  • Migration Guides: Generate and update migration notes and lifecycle warnings automatically when breaking changes are introduced to the codebase.
namedocs-auto-sync
descriptionAutomatically update repository documentation whenever code changes (add/edit/refactor) occur. Use when modifying source code, public APIs/contracts, rendering/interaction/data/compute logic, diagnostics, or build/release/CI flows so docs stay consistent without asking.

Docs Auto Sync

Overview

Keep documentation in sync with code changes by updating the required docs in the same change set. Default to automatic updates; only ask if a required detail is missing.

Workflow

  1. Classify the change scope.
  • Identify layers touched (core/rendering/interaction/data/compute/api/diagnostics/ci/packaging).
  • Note any contract, lifecycle, or budget changes (see AGENTS.md).
  1. Choose docs to update.
  • Use references/doc-impact-matrix.md to map change types to docs.
  • If multiple layers are touched, add a short design note per AGENTS.md.
  • For contract changes, add version notes and a migration note.
  1. Update docs automatically.
  • Apply edits in the same change set.
  • Add a rationale to any new doc: why it belongs in chart-engine and not quant-lab.
  • Keep cross-links and references consistent.
  1. Validate before final response.
  • Ensure doc DoD: cross-links updated, invariants/SLOs referenced, version notes added.
  • Summarize which docs were updated and why.

Resources

  • references/doc-impact-matrix.md - change types and required docs.