Claude Code Plugins

Community-maintained marketplace

Feedback

ln-160-docs-auditor

@levnikolaevich/claude-code-skills
12
0

Audit project documentation quality across 6 categories (Hierarchy, SSOT, Compactness, Requirements, Actuality, Legacy). 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.

Install Skill

1Download skill
2Enable skills in Claude

Open claude.ai/settings/capabilities and find the "Skills" section

3Upload to Claude

Click "Upload skill" and select the downloaded ZIP file

Note: Please verify skill by going through its instructions before using it.

SKILL.md

name ln-160-docs-auditor
description Audit project documentation quality across 6 categories (Hierarchy, SSOT, Compactness, Requirements, Actuality, Legacy). 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.

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

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: Run 6 category checks (see Audit Categories below)
  4. Score: Calculate X/10 per category
  5. Report: Output findings and recommended actions

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
4 Requirements Compliance Correct sections per doc type; within size limits; proper formatting; no code blocks (text descriptions only)
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

Output Format

## 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 |
| **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

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 and concepts in text, not code. Code belongs in codebase, docs explain WHY and HOW in words.
  • 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: 1.0.0 Last Updated: 2025-12-20