document-sync_skill

Overview

This skill analyzes your live codebase, tech stack, configuration, and architecture to ensure every documentation file is current and accurate. It never assumes—every doc claim is verified against the real system and flagged with evidence and a trust score. It can suggest, dry-run, or auto-update docs while preserving backups and diffs.

How this skill works

The skill performs a full system scan to detect languages, frameworks, dependencies, project structure, and deployment targets, producing a system_state.json and feature report. It then inventories all documentation and cross-references each claim with source code and configuration, producing a doc_verification_report and update plan. Finally, it can generate suggested edits, dry-run patches, or create PR-ready updates with clear diffs and backups based on user-selected conservatism.

When to use it

• Before releases to ensure docs match code and config
• When onboarding new contributors or auditing project health
• After architectural changes, dependency upgrades, or migrations
• To find undocumented config variables and hidden features
• When preparing public API docs or SDK reference material

Best practices

• Run a full system scan (system_scan.py) before running verification
• Start in dry-run or suggest mode to review proposed changes
• Protect sensitive docs via protected_docs config and require review for removals
• Keep a conservative workflow: dry-run -> suggest -> auto-update only after review
• Always commit backups and include clear change summaries for each update

Example use cases

• Detect and remove documentation references to deprecated databases or libraries
• Automatically add missing API routes or feature descriptions found in source files
• Generate a prioritized docs_update_plan.md for release teams
• Validate that environment variables documented actually exist and match .env or config schemas
• Create a PR with safe, evidence-backed doc changes for reviewer approval