agentleFS
Destynova2Destynova2/cli-code-skills/cli-audit-sync/SKILL.md

cli-audit-sync

Skill5 starsChanged 8 months agoMITView on GitHub

Verify documentation-code coherence: detect stale references, broken links, terminology drift, outdated diagrams, and non-working examples. Use when the user wants to check if docs match reality, detect doc drift, verify README accuracy, find stale documentation, or says 'is my doc up to date', 'check coherence', 'sync docs', 'doc drift', 'stale docs', 'verify documentation'. Also triggers on 'broken links', 'outdated references', 'docs match code'.

1 other project uses a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Documentation is a contract with the reader: Every statement in docs is an implicit promise: "this is true right now." This skill finds …

    line 30
  2. Very specific:

    Read references/layers.md for detailed check tables, methodology, and safety rules per layer.

    line 42
  3. Very specific:

    Read references/duplication-rules.md for the 25 reproducible rules with citations (Hunt/Thomas, Fowler, Metz, McCabe, Diátaxis, SSOT).

    line 73

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Optimization: This skill uses on-demand loading. Heavy content lives in references/ and is loaded only when needed.

Language rule: Skill instructions are written in English. When generating user-facing output, detect the project's primary language (from README, comments, docs, commit messages) and produce the report in that language. If the project is bilingual, ask the user which language to use before proceeding.

Audit Sync — Documentation-Code Coherence Verifier

Detect every place where documentation says one thing and the code says another.

"A stale diagram is worse than no diagram. A README with wrong commands is worse than no README."

Core Principle

Documentation is a contract with the reader. Every statement in docs is an implicit promise: "this is true right now." This skill finds broken promises.

Gotchas — read ../gotchas.md before producing output to avoid known mistakes.

Three-Layer Verification

LayerStyleWhat it checksSeverity focus
Layer 1 — Structurallychee-styleInternal links, anchors, images, code file refs, importsBroken refs
Layer 2 — SemanticDocPrism/SwimmModule/function/type names, endpoints, CLI flags, env vars, versionsStale names
Layer 3 — ExecutableDocs-as-TestsShell commands, install steps, code snippets, Mermaid diagrams, demo kits (docs/demos/**/DEMO.md: each beat's command vs its declared expected output)Broken examples, stale demo

Read references/layers.md for detailed check tables, methodology, and safety rules per layer.

Workflow

Mitosis — Scale to doc volume

S/M/L/XL semantics are canonical in ../shared/tiering.md — the table below specializes them to doc-file count and audit-layer depth.

TierSignalDepth
S1-2 doc filesLayer 1 only + quick Layer 2
M5-15 doc filesLayer 1 + Layer 2 + sample Layer 3
L20+ doc filesAll 3 layers + terminology map + diagram verification

Step 1 — Discover documentation

Glob: **/*.md, docs/**/*, README*, CHANGELOG*, CONTRIBUTING*

Step 2 — Build code index (source of truth)

  • File tree (all source files)
  • Exported symbols (public functions, types, modules)
  • Route definitions, config keys, CLI commands/flags
  • Dependencies + version from manifest

Step 3 — Run layers (parallel)

Launch sub-agents for each applicable layer. Read references/layers.md for detailed checks per layer.

Step 3b — Duplication scan (DRY/SSOT/KISS rules)

Read references/duplication-rules.md for the 25 reproducible rules with citations (Hunt/Thomas, Fowler, Metz, McCabe, Diátaxis, SSOT).

Run 5 rule families:

  • D rules — Doc-doc duplication (same paragraph/table/code block in ≥2 docs)
  • C rules — Code-code cross-format duplication (Makefile + CI YAML + scripts + docs)
  • S rules — SSOT violations (CLI flags, version strings, config defaults code↔doc)
  • M rules — Anti-false-DRY (Sandi Metz: don't escalate < 3 instances, flag wrong abstractions)
  • I rules — Information-theoretic duplication index (gzip ratio, optional)

Apply Fowler's Rule of Three: 1 = ignore, 2 = warn, 3+ = error. Exception: if 2 instances have different values (drift), it's immediately critical.

This fills a gap NO mainstream tool covers: cross-format command/env duplication detection.

Step 4 — Synthesize report

Output Format

# Doc-Code Sync Report — {project-name}

**Date:** {date}
**Files scanned:** {n} docs, {m} source files
**Coherence score:** {X}/10

## Summary

| Layer | Checks | Passed | Failed | Warnings |
|-------|--------|--------|--------|----------|

## Critical Issues (fix now)

| # | File:Line | Issue | What docs say | What code says |

## Warnings (fix soon)

## What's in sync (good)

## Terminology Map (if tier L)

Scoring

ScoreMeaning
10/10Every doc reference matches code. Zero drift
8-9Minor warnings only (terminology, info-level)
6-7Some stale references but no broken commands
4-5Multiple broken references, outdated sections
1-3Documentation is actively misleading

Integration with other cli-* skills

SkillRelationship
cli-audit-docScores doc quality. cli-audit-sync scores doc accuracy
cli-audit-driftChecks contract-code coherence. cli-audit-sync checks doc-code coherence
cli-forge-schemaGenerates diagrams. cli-audit-sync verifies existing diagrams match code
cli-forge-readmeGenerates READMEs. cli-audit-sync verifies existing README matches reality
cli-cycleCalls cli-audit-sync as part of the full project review; emit .claude/cli-audit-sync.json per ../shared/result-schema.md for orchestrator aggregation

Dynamic Handoffs

Condition detectedRecommendWhy
Shell commands in docs don't work/cli-audit-shellAudit the scripts referenced
README architecture section outdated/cli-forge-readmeUpdate README
Stale diagrams/cli-forge-schemaRegenerate from current code
API reference mentions deleted functions/cli-audit-codeCheck for dead code
Demo kit beats no longer match code (commands fail or output differs)/cli-forge-demoRegenerate the stale demo from the current golden path

Rule: Recommend, don't auto-execute.

What this skill does NOT do

  • Does not fix docs — it reports. Use cli-forge-* skills to fix
  • Does not execute unsafe commands — dry-run verification only
  • Does not check external URLs — no network calls
  • Does not replace linters — Vale/markdownlint handle prose style, this handles truth

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.