📋 ln-160-docs-auditor

Documentation Quality Auditor - State Diagram

📋 Workflow Overview

Discovery
Audit Checks
Output
graph TD Start([Start: Documentation Audit]) --> Scan[Phase 1: Scan
Find all .md files] Scan --> BuildTree[Phase 2: Build Tree
Construct hierarchy from CLAUDE.md] BuildTree --> Cat1[Category 1: Hierarchy & Links
Root, reachability, broken links] Cat1 --> Cat2[Category 2: Single Source of Truth
Detect duplication, check ownership] Cat2 --> Cat3[Category 3: Context Compactness
Size limits, verbose phrases] Cat3 --> Cat4[Category 4: Requirements Compliance
Sections, formatting, structure] Cat4 --> Cat5[Category 5: Actuality
Docs vs code, runnable examples] Cat5 --> Cat6[Category 6: Legacy Cleanup
History, deprecated, outdated] Cat6 --> Score[Phase 3: Calculate Scores
X/10 per category] Score --> Report[Phase 4: Generate Report
Findings + Recommended Actions] Report --> Output([Output: Audit Report]) classDef discovery fill:#e1f5fe,stroke:#01579b classDef processing fill:#fff3e0,stroke:#e65100 classDef action fill:#e8f5e9,stroke:#2e7d32 class Start,Scan,BuildTree discovery class Cat1,Cat2,Cat3,Cat4,Cat5,Cat6 processing class Score,Report,Output action

📊 Scoring Rules

ScoreMeaning
10/10No issues
8-9/10Minor issues
6-7/10Moderate issues
4-5/10Significant issues
1-3/10Critical issues