🎯

ln-600-docs-auditor

🎯Skill

from levnikolaevich/claude-code-skills

VibeIndex|
What it does

Audits project documentation quality across 8 categories, generating a comprehensive compliance score and actionable recommendations for improvement.

πŸ“¦

Part of

levnikolaevich/claude-code-skills(85 items)

ln-600-docs-auditor

Installation

Claude CodeAdd plugin in Claude Code
/plugin add levnikolaevich/claude-code-skills
git cloneClone repository
git clone https://github.com/levnikolaevich/claude-code-skills.git ~/.claude/skills
πŸ“– Extracted from docs: levnikolaevich/claude-code-skills
12Installs
-
AddedFeb 4, 2026

Skill Details

SKILL.md

Audit project documentation quality across 8 categories (Hierarchy, SSOT, Compactness, Requirements, Actuality, Legacy, Stack Adaptation, Semantic Content). Delegates to ln-601 for deep semantic verification of project documents. Use when documentation needs quality review, after major doc updates, or as part of ln-100-documents-pipeline. Outputs Compliance Score X/10 per category + Findings + Recommended Actions.

Overview

# Documentation Auditor

Audit project documentation quality. Universal for any tech stack.

Purpose

  • Proactively compress - find all opportunities to reduce size while preserving value
  • Eliminate meaningless, redundant, and verbose content
  • Convert prose to structured formats (tables, lists)
  • Verify documentation hierarchy with CLAUDE.md as root
  • Detect duplication and enforce Single Source of Truth
  • Ensure docs match current code state
  • Semantic verification - delegate to ln-601 to verify content matches SCOPE and codebase reality

Invocation

  • Direct: User invokes for documentation quality review
  • Pipeline: Called by ln-100-documents-pipeline (Phase 5, if auditDocs=true)

Workflow

  1. Scan: Find all .md files in project (CLAUDE.md, README.md, docs/**)
  2. Build Tree: Construct hierarchy from CLAUDE.md outward links
  3. Audit Categories 1-7: Run structural checks (see Audit Categories below)
  4. Semantic Audit (Category 8): For each project document, delegate to ln-601-semantic-content-auditor
  5. Score: Calculate X/10 per category (including semantic scores from ln-601)
  6. Report: Output findings and recommended actions

Phase 4: Semantic Audit Delegation

For each project document (excluding tasks/, reference/, presentation/):

```

FOR doc IN [CLAUDE.md, docs/README.md, docs/project/*.md]:

result = DELEGATE ln-601-semantic-content-auditor {

doc_path: doc,

project_root: project_root,

tech_stack: detected_stack

}

semantic_findings.append(result.findings)

semantic_scores[doc] = result.scores

```

Target documents: CLAUDE.md, docs/README.md, docs/documentation_standards.md, docs/principles.md, docs/project/*.md

Excluded: docs/tasks/, docs/reference/, docs/presentation/, tests/

Audit Categories

| # | Category | What to Check |

|---|----------|---------------|

| 1 | Hierarchy & Links | CLAUDE.md is root; all docs reachable via links; no orphaned files; no broken links |

| 2 | Single Source of Truth | No content duplication; duplicates replaced with links to source; clear ownership |

| 3 | Proactive Compression | Eliminate verbose/redundant content; prose→tables; remove meaningless info; compress even under-limit files; see [size_limits.md](references/size_limits.md) |

| 4 | Requirements Compliance | Correct sections; within size limits; no code blocks (tables/ASCII diagrams/text only); stack-appropriate doc links |

| 5 | Actuality (CRITICAL) | Verify facts against code: paths exist, functions match, APIs work, configs valid; outdated docs are worse than none |

| 6 | Legacy Cleanup | No history sections; no "was changed" notes; no deprecated info; current state only |

| 7 | Stack Adaptation | Links/refs match project stack; no Python examples in .NET project; official docs for correct platform |

| 8 | Semantic Content | Delegated to ln-601: Content matches SCOPE; serves project goals; descriptions match actual code behavior; architecture/API docs reflect reality |

Output Format

```markdown

Documentation Audit Report - [DATE]

Compliance Score

| Category | Score | Issues |

|----------|-------|--------|

| Hierarchy & Links | X/10 | N issues found |

| Single Source of Truth | X/10 | N duplications |

| Proactive Compression | X/10 | N compression opportunities |

| Requirements Compliance | X/10 | N violations |

| Actuality | X/10 | N mismatches with code |

| Legacy Cleanup | X/10 | N legacy items |

| Stack Adaptation | X/10 | N stack mismatches |

| Semantic Content | X/10 | N semantic issues (via ln-601) |

| Overall | X/10 | |

Critical Findings

  • [ ] [Category] path/file.md:line - Issue description. Action: Fix suggestion.

Recommended Actions

| Priority | Action | Location | Category |

|----------|--------|----------|----------|

| High | Remove duplicate section | docs/X.md | SSOT |

| Medium | Add link to CLAUDE.md | docs/Y.md | Hierarchy |

```

Scoring Rules

| Score | Meaning |

|-------|---------|

| 10/10 | No issues |

| 8-9/10 | Minor issues (formatting, small redundancies) |

| 6-7/10 | Moderate issues (some duplication, missing links) |

| 4-5/10 | Significant issues (orphaned docs, outdated content) |

| 1-3/10 | Critical issues (major mismatches, broken hierarchy) |

Reference Files

  • Size limits and targets: [references/size_limits.md](references/size_limits.md)
  • Detailed checklist: [references/audit_checklist.md](references/audit_checklist.md)

Critical Notes

  • Fix content, not rules: NEVER modify standards/rules files (_standards.md, _rules.md, *_limits.md) to make violations pass. Always fix the violating files instead.
  • Verify facts against code: Actively check every path, function name, API, config mentioned in docs. Run commands. Outdated docs mislead - they're worse than no docs.
  • Compress always: Size limits are upper bounds, not targets. A 100-line file instead of 300 is a win. Always look for compression opportunities.
  • Meaningless content: Remove filler words, obvious statements, over-explanations. If it doesn't add value, delete it.
  • No code in docs: Documents describe algorithms in tables or ASCII diagrams. Code belongs in codebase.

- Forbidden: Code blocks, implementation snippets

- Allowed: Tables, ASCII diagrams, Mermaid, method signatures (1 line)

- Instead of code: "See [Official docs](url)" or "See [src/file.cs:42](path#L42)"

  • Format Priority: Tables/ASCII > Lists (enumerations only) > Text (last resort)
  • Stack adaptation: Verify all documentation references match project stack. .NET project must not have Python examples. Check official doc links point to correct platform (Microsoft docs for C#, MDN for JS, etc.)
  • Code is truth: When docs contradict code, always update docs. Never "fix" code to match documentation.
  • Delete, don't archive: Legacy content should be removed, not moved to "archive"
  • No history: Documents describe current state only; git tracks history

---

Version: 4.0.0

Last Updated: 2026-01-28

More from this repository10

πŸͺ
levnikolaevich-claude-code-skillsπŸͺMarketplace

Official marketplace for Agile Linear Workflow plugin - complete end-to-end automation for software development teams using Linear. Includes 7XX Project Bootstrap series for technology-agnostic project migration.

🎯
ln-140-test-docs-creator🎯Skill

Generates comprehensive test documentation with testing strategy and test organization structure for software projects.

🎯
ln-110-project-docs-coordinator🎯Skill

Coordinates project documentation by gathering context once, detecting project type, and delegating document creation to 5 specialized workers.

🎯
ln-114-frontend-docs-creator🎯Skill

Generates design guidelines documentation for frontend projects with WCAG 2.1 compliance when a frontend framework is detected.

🎯
ln-113-backend-docs-creator🎯Skill

Generates backend documentation files (API spec and database schema) automatically when backend or database technologies are detected in a project.

🎯
ln-610-code-comments-auditor🎯Skill

Audits code comments and docstrings across 6 quality categories, generating a comprehensive compliance score and actionable recommendations for improvement.

🎯
ln-115-devops-docs-creator🎯Skill

Generates a comprehensive runbook.md for DevOps setup, dynamically tailored to project's Docker configuration and deployment specifics.

🎯
ln-772-error-handler-setup🎯Skill

Configures global exception handling middleware for .NET and Python backend applications with standardized error responses.

🎯
ln-120-reference-docs-creator🎯Skill

Generates reference documentation structure and smart documents for project tech stack, creating only justified architectural decision records and guides.

🎯
ln-625-dependencies-auditor🎯Skill

Audits dependencies for outdated packages, unused imports, unnecessary libraries, and custom implementations, providing actionable recommendations.