doc-synclisted

Keeps your project docs honest about what the code actually does. It rebuilds the status or progress file from real facts (what's registered in the code, which branches are merged, how far the build has really got, today's date), and for the vision or architecture docs it points out what's gone stale and lets you approve the change instead of rewriting your prose. Good for when you've merged a few branches, shipped a feature, or just suspect the status file is lying. Works in any codebase.
mercedesperezcapilla-gif/claude-skills · ★ 0 · AI & Automation · score 75

Install: claude install-skill mercedesperezcapilla-gif/claude-skills

# doc-sync Documentation rots because it is written once and edited by hand. This skill keeps it true to the repo with a simple rule: **automate the snapshot, human-curate the narrative.** Those are two different kinds of document and they must be treated differently — collapsing them is how doc-sync tools either go stale or quietly mangle carefully-written prose. ## The two kinds of doc - **Snapshot docs** — a `STATUS.md`, `PROGRESS.md`, or "current state" section. These answer *"what exists right now?"*. They decay every working session and are safe to **regenerate from facts**. doc-sync rewrites these. - **Curated docs** — a vision / "why" doc, an architecture / "how" doc, a README narrative. These are deliberate prose that change rarely. doc-sync **never rewrites them unprompted** — it only *flags* discrepancies and proposes edits for the user to approve. Auto-editing prose is how you degrade the best writing in the repo. If you are unsure which bucket a doc is in, ask. When in doubt, treat it as curated (flag-only) — the cost of a missed flag is lower than the cost of garbling prose. ## How the user configures it Look for configuration in this order; if none exists, ask the user which docs are snapshot vs curated and offer to write a `.doc-sync.json`. 1. **`.doc-sync.json`** at the repo root: ```json { "snapshot": ["STATUS.md"], "curated": ["docs/VISION.md", "ARCHITECTURE.md"], "facts": { "components": "grep -nE 'id=\"' src/re