docs-sync

Audit ADRs, runbooks, and API docs against codebase behavior.

15|5|Updated May 17, 2026
One-click install
npx skills add https://github.com/cropsgg/skills --skill docs-sync-cropsgg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/cropsgg/skills/tree/main/skills/planning/docs-sync
Command: npx skills add https://github.com/cropsgg/skills --skill docs-sync-cropsgg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts after implementation, causing knowledge decay and onboarding issues. This skill aligns ADRs, runbooks, and API docs with the actual behavior of the system to maintain a single source of truth.

Core Features & Use Cases

  • Doc-audit: cross-checks code paths against the published docs and runbooks to identify drift.
  • Link maintenance: ensures references and ADRs stay linked to the current implementation.
  • Onboarding readiness: accelerates handoffs by presenting a coherent, up-to-date documentation surface.

Quick Start

Run the docs-sync reconciliation against the latest main commit to align documentation with current implementation.

Frequently Asked Questions about docs-sync

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

FAQPage Schema
How do I check if my API documentation has drifted from the codebase?

To check API documentation drift, run a doc-audit reconciliation against your latest main commit to cross-check published API docs and runbooks with actual code paths, identifying discrepancies to maintain a single source of truth.

What causes documentation drift and knowledge decay in software maintenance?

Documentation drift and knowledge decay occur when ADRs, runbooks, and API docs are not updated after implementation changes. Reconciling documentation against the codebase enforces explicit migration notes and environment details to ensure traceability.

How do I keep ADRs and runbooks aligned with current implementation behavior?

To keep ADRs and runbooks aligned with implementation behavior, reconcile them against the codebase to maintain cross-links and references, ensuring traceability from docs to code and preventing onboarding issues caused by outdated documentation.

Can I automate onboarding readiness checks using existing runbooks and ADRs?

You can automate onboarding readiness by auditing runbooks and ADRs against the codebase to present a coherent, up-to-date documentation surface, accelerating handoffs by verifying explicit install prerequisites and environment details are accurately documented.

What is the best way to ensure traceability from API docs to code during change management?

The best way to ensure traceability from API docs to code during change management is enforcing cross-links and explicit migration notes through documentation reconciliation, aligning published docs with the latest commit to prevent audit incidents.