ln-600-docs-auditor

Audit Markdown documentation across six categories and output structured findings.

534|73|Updated Oct 24, 2025
One-click install
npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-600-docs-auditor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ln-600-docs-auditor
Source: https://github.com/levnikolaevich/claude-code-skills/tree/main/ln-600-docs-auditor
Command: npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-600-docs-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audits documentation quality across categories, identifies duplication, and recommends actions to improve structure and accuracy.

Core Features & Use Cases

  • Evaluate 6 documentation categories: hierarchy, SSOT, compression, requirements, actuality, legacy
  • Produce compliance score and actionable findings
  • Recommend concrete remediation steps

Quick Start

Run the auditor to generate a documentation audit report for the current project.

Frequently Asked Questions about ln-600-docs-auditor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit documentation quality across my project?

Documentation auditing scans Markdown files in your repository to evaluate hierarchy, SSOT (single source of truth), compression, requirements coverage, actuality, and legacy issues. The auditor builds a CLAUDE.md-based hierarchy and produces a compliance score with actionable findings to improve structure and accuracy.

What documentation issues does the auditor identify?

The auditor detects six categories of issues: hierarchy problems (structure and organization), SSOT violations (duplication across docs), compression failures (unnecessary verbosity), missing requirements, outdated information, and legacy content. Each category receives a score and remediation recommendations.

Can I use the auditor in CI pipelines?

Yes. The auditor is designed for post-update reviews and CI pipeline integration to surface documentation quality issues automatically. It scans Markdown-based projects with CLAUDE.md as root, README.md, and docs/ directories, then outputs structured findings for gating or reporting.

What file formats does the documentation auditor support?

The auditor works with Markdown-based projects, scanning CLAUDE.md (as the root reference), README.md, and docs/ directories. It builds hierarchy from CLAUDE.md structure and evaluates all Markdown files against the six audit categories.

What output does the auditor produce?

The auditor generates a compliance score, per-category scores, and structured findings that include identified issues and concrete remediation steps. Output is formatted for integration into reports, dashboards, or CI workflows.

Do I need existing documentation structure to run the auditor?

The auditor requires Markdown files organized with CLAUDE.md as the root hierarchy reference. It works best on projects with established README.md and docs/ directories, though it will audit whatever Markdown structure exists and identify hierarchy gaps.