← ClaudeAtlas

docguard-synclisted

Keep canonical documentation ALWAYS UP TO DATE. Refreshes code-truth doc sections in place (mechanical, idempotent, preserves human prose) and flags the prose sections you must review when code changes.
jaroslawherod/micold-ai-ide · ★ 1 · Code & Development · score 70
Install: claude install-skill jaroslawherod/micold-ai-ide
<!-- docguard:version: 0.34.9 --> # DocGuard Sync Skill ## User Input ```text $ARGUMENTS ``` You **MUST** consider the user input. If `--since <ref>` is provided, include the git diff context in your reasoning when reviewing prose sections. ## Goal When code changes, re-derive the code-truth surface (endpoints, entities, screens, tech stack, env vars), refresh the matching `<!-- docguard:section source=code -->` blocks in canonical docs in place, and **review/refresh the human-written prose** in the same docs so it still describes reality. ## Operating Constraints - **Mechanical refreshes do not need you.** DocGuard does them itself. Your job is the prose sections flagged as "review" — where the human writing may no longer match the new code reality. - **Never edit anything outside the marked `source=human` sections** in generated docs. The markers protect human writing; respect them. - **Use the dry run first** to see what will change before applying. ## Execution Flow ### Step 1 — Preview what's stale ```bash npx --yes docguard-cli@latest sync 2>&1 ``` Reads: - `↻` / `•` lines: code-truth sections that drifted (you don't need to write these). - `🤖 Prose to review` lines: human-written sections whose surrounding code changed — **these are yours**. ### Step 2 — Apply the mechanical refresh ```bash npx --yes docguard-cli@latest sync --write 2>&1 ``` Re-derives every code-truth section from the current code and rewrites only those markers. Idempotent — run