with one click
ln-611-docs-structure-auditor
// Checks hierarchy, links, SSOT, compression, requirements compliance, freshness, legacy cleanup. Use when auditing documentation structure.
// Checks hierarchy, links, SSOT, compression, requirements compliance, freshness, legacy cleanup. Use when auditing documentation structure.
[HINT] Download the complete skill directory including SKILL.md and all related files
| name | ln-611-docs-structure-auditor |
| description | Checks hierarchy, links, SSOT, compression, requirements compliance, freshness, legacy cleanup. Use when auditing documentation structure. |
| allowed-tools | Read, Grep, Glob, Bash, mcp__hex-line__outline |
| license | MIT |
| model | claude-sonnet-4-6 |
Paths: File paths (
references/,../ln-*) are relative to this skill directory.
Type: L3 Worker
Specialized worker auditing structural quality of project documentation.
.md files in project, build hierarchy from AGENTS.md when presentMANDATORY READ: Load references/audit_worker_core_contract.md, references/docs_quality_contract.md, and references/markdown_read_protocol.md.
Optional rule catalog: load references/docs_quality_rules.json only when exact rule IDs, path matrices, or allowlisted placeholder exceptions are needed.
Tool policy: follow host AGENTS.md MCP preferences; load references/mcp_tool_preferences.md and references/mcp_integration_patterns.md only when host policy is absent or MCP behavior is unclear.
Receives contextStore with: tech_stack, project_root, output_dir.
hex-line is optional for this doc-only worker. Use it as an accelerator for large markdown outlines and targeted reads when available; otherwise continue with built-in Read/Grep/Glob/Bash.
docs/project/.context/doc_registry.json as the first routing source when available.md files in project (AGENTS.md, CLAUDE.md, README.md, docs/**)Quick Navigation + Agent Entry + MaintenanceAGENTS.md outward links when present, otherwise from CLAUDE.mdreferences/templates/audit_worker_report_template.md, write to {output_dir}/611-structure.md in single Write call| # | Category | What to Check |
|---|---|---|
| 1 | Hierarchy & Links | AGENTS.md is canonical root when present; 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 to tables; remove meaningless info; compress even under-limit files; see size_limits.md |
| 4 | Requirements Compliance | Correct header markers, correct top sections, within size limits, no illegal code blocks, stack-appropriate doc links |
| 5 | Freshness Indicators | Detect staleness signals: dates >6 months in content, unsupported API/tool references, TODO/FIXME markers, placeholder text left in place; deep fact-checking handled by dedicated worker |
| 6 | Legacy Cleanup | No history sections; no "was changed" notes; no unsupported info; current state only |
| 7 | Stack Adaptation | Links/refs match project stack; no Python examples in .NET project; official docs for correct platform |
| 8 | Import Pattern Compliance | When AGENTS.md exists at repo root, CLAUDE.md must contain exactly one @AGENTS.md line and a bounded harness-specific delta (≤50 lines total). Any content in CLAUDE.md that duplicates AGENTS.md is drift. See references/agent_instructions_writing_guide.md for rationale |
| Issue Type | Severity |
|---|---|
| Staleness indicators (old dates, unsupported refs, TODO markers) | MEDIUM |
| Broken links, orphaned docs | HIGH |
| Content duplication | MEDIUM |
| Missing compression opportunity | LOW |
| Legacy/history content | MEDIUM |
| Wrong stack references | HIGH |
Import pattern drift (duplicated AGENTS.md content in CLAUDE.md, oversized stub, missing @AGENTS.md line) | HIGH |
MANDATORY READ: Load references/audit_scoring.md.
MANDATORY READ: Load references/templates/audit_worker_report_template.md.
Write JSON summary per references/audit_summary_contract.md. In managed mode the caller passes both runId and summaryArtifactPath; in standalone mode the worker generates its own run-scoped artifact path per shared contract.
Write report to {output_dir}/611-structure.md with category: "Documentation Structure" and checks: hierarchy_links, ssot, compression, requirements_compliance, freshness_indicators, legacy_cleanup, stack_adaptation, import_pattern_compliance.
Return summary per references/audit_summary_contract.md.
Standalone mode still writes the same JSON summary to a worker-owned run-scoped artifact path per shared contract.
Apply the already-loaded references/audit_worker_core_contract.md.
tech_stack to apply stack-specific checks (e.g., .NET vs Node.js doc standards)file:line for programmatic navigationdocs_quality_contract.md / docs_quality_rules.jsonApply the already-loaded references/audit_worker_core_contract.md.
{output_dir}/611-structure.md (atomic single Write call)Version: 1.0.0 Last Updated: 2026-03-01