doc-audit

Solid

Documentation drift auditor and normalizer for CLAUDE.md / AGENTS.md projects (supports Claude Code, Codex, and any project using agent instruction files at root and/or per module). Use when the user says "audit docs", "check doc freshness", "doc drift", "docs out of date", "文档审计", "文档漂移", "检查文档", "文档同步", "memory index", "MEMORY.md check", "normalize docs", "整理文档", "更新文档", "update docs", "doc health", "文档健康". Also triggers implicitly when user mentions stale docs, wrong ports in CLAUDE.md / AGENTS.md, or missing memory entries.

AI & Automation 3 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 79/100

Stars 20%
20
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Doc Garden — Documentation Drift Audit & Normalization Audit project documentation against codebase reality. Detect drift, report it, optionally fix. ## NEVER - Never update a doc based on what the code *should* look like — only sync to what it *actually* is now - Never fix docs for a section you didn't audit — partial fixes create false confidence - Never auto-fix non-deterministic issues without user confirmation - Never modify code based on documentation — docs follow code, not the other way ## Modes ``` /doc-audit → Report only, no file changes /doc-audit fix → Report + auto-fix deterministic issues (ghost refs, path redirects) /doc-audit normalize → Report + suggest structural fixes, user confirms each ``` ## Two-Layer Architecture ### Layer 1: Universal Audit Core (this file) Always executed. Project-agnostic drift detection. ### Layer 2: Project-Specific Config (`.claude/doc-garden.json`) Generated on first run. Records doc hierarchy, environment domains, staleness threshold. ### Config Loading Flow ``` On audit trigger: 1. Call has_config(cwd) to check .claude/doc-garden.json - Exists → load_config(cwd), proceed to audit - Missing → enter Config Generation Workflow (see below) 2. User says "update config" or "重新生成配置" → re-enter generation workflow ``` `load_config()` `deep_merge`s the user's file on top of `DEFAULT_CONFIG`, so a stale config missing newer fields (e.g. `doc_patterns`, `path_resolvers`) inherits sensible...

Details

Author
Wubabalala
Repository
Wubabalala/claude-skills
Created
4 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

doc-audit

Audit project documentation against current code to find drift. Use when docs have fallen significantly behind code and you need a triage list before rewriting. Produces DOC_AUDIT.md with per-file verdicts (OK / minor / rewrite / delete). Does NOT auto-rewrite — user decides.

6 Updated today
Jiahui-Gu
Data & Documents Listed

claude-file-audit

Audit the repo's own documentation — CLAUDE.md, README.md, CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, LICENSE, the community-health files under .github/ (issue forms, PR template, FUNDING.yml) and every committed file under .claude/ (rules, skills, launch config) — for staleness, contradictions and drift from the code, and periodically refresh the criteria from current Claude Code/harness capabilities. Use when asked to audit or review the Claude files, rules, skills, CLAUDE.md, the root docs or the GitHub issue/PR templates, to check whether the repo's own docs still match reality, or to clean up the agent-facing documentation. Produces a ranked report; files issues only with your approval.

0 Updated today
ChulioZ
AI & Automation Listed

audit

Audit the Claude Code instruction/memory layer — CLAUDE.md, CLAUDE.local.md, .claude/rules/, and auto-memory — against a codified checklist derived from official Claude Code documentation. Use when: 'audit CLAUDE.md', 'memory health', 'audit rules', 'is my CLAUDE.md too long', 'prune instructions', after CLAUDE.md/rules changes or a Claude Code upgrade; actions: audit (default), fix, update, report.

4 Updated today
melodic-software