ai-skills/skills/docs-sync-audit/SKILL.md

name, description, version, user-invocable, author

name	description	version	user-invocable	author
docs-sync-audit	Analyzes repository delta since the last documentation update and synchronizes the Single Source of Truth (docs/, wiki, or README) with the current codebase state.	1.3.0	true	Rootiest

Documentation Synchronization & Audit Skill

Objective

To ensure project documentation accurately reflects the current state of the codebase by identifying the "Single Source of Truth" (SSoT) (e.g., a docs/ directory or wiki) and prioritizing updates there. The README.md is updated concurrently only for high-level changes or if it serves as the SSoT.

Execution Protocol

Phase 0: SSoT Discovery

1. Locate Documentation Root: Scan the repository structure for dedicated documentation directories (e.g., docs/, wiki/, website/docs/) or configuration files (e.g., mkdocs.yml, docusaurus.config.js).
2. Establish SSoT: If a dedicated documentation structure exists, designate it as the SSoT. If absent, fall back to README.md as the primary SSoT.

Phase 1: Delta Analysis

1. Time-Travel Check: Locate the last commit where the SSoT files were modified.
2. Feature Diff: Analyze all code changes (files added, functions modified, dependencies updated) from that commit to the present HEAD.
3. Extraction: Identify new environment variables, CLI flags, installation steps, or logic changes that are not yet documented.

Phase 2: The Pruning & Update Audit

Perform a targeted comparison of the SSoT against the current code:

• Route Updates: Direct detailed API, configuration, and architectural updates to their respective files within the SSoT (docs/ or wiki).
• Prune: Remove any setup steps, dependencies, or "Coming Soon" features from the SSoT that no longer exist or have been replaced.
• Correct: Update version numbers, file paths, and command-line examples to match the current implementation.
• Synthesize: Add concise documentation for new features identified in Phase 1.
• README Alignment: If docs/ is the SSoT, update the README.md only to reflect critical, high-level changes (e.g., Quick Start, Installation) or to ensure it properly links to the newly updated sections in the SSoT.

Phase 3: Structural Integrity Check

Ensure the updated SSoT (and README, if applicable) includes or updates these critical sections:

1. Quick Start: Are the commands (e.g., cargo run, npm start) still the primary entry points?
2. Configuration: Are all current .env or config keys listed?
3. Usage Examples: Do the provided code snippets actually compile/run with the current API?

Constraints & Rules

• Hierarchy Enforcement: Never duplicate deep technical documentation in the README if a docs/ folder exists. Use the README as a high-level landing page that points to the SSoT.
• Minimalism: Maintain the existing tone of the documentation. Do not add "fluff" or marketing language unless the original document uses it.
• No Hallucinations: If a feature's purpose is unclear from the code diff, add a TODO comment or ask the user for clarification rather than guessing.
• Markdown Standards: Use standard GFM (GitHub Flavored Markdown) or MDX if applicable to the SSoT. Ensure all code blocks have the correct language identifier for syntax highlighting.

Trigger Scenarios

• Direct Command: The user invokes /docs-sync-audit, /readme-sync-audit, or /update-docs.
• Natural Language: User says "Update the docs", "Sync the wiki", or "Sync the README with my recent changes."
• Contextual Suggestion: Trigger automatically if the model detects significant changes to public APIs, CLI arguments, or environment variables without a corresponding documentation update.