Loading...
Loading...
Coordinates 4 documentation audit workers (structure, semantic, fact-check, code comments). Delegates parallel audits, aggregates into docs/project/docs_audit.md.
npx skill4agent add levnikolaevich/claude-code-skills ln-610-docs-auditorPaths: File paths (,shared/,references/) are relative to skills repo root. If not found at CWD, locate this SKILL.md directory and go up one level for repo root.../ln-*
docs/project/docs_audit.mddocs/project/docs_audit.mdCLAUDE.mddocs/README.mdpackage.jsonrequirements.txtgo.modCargo.tomldocs/project/.mdFOR doc IN [CLAUDE.md, docs/README.md, docs/documentation_standards.md,
docs/principles.md, docs/project/*.md]:
IF doc exists AND doc NOT IN [docs/tasks/*, docs/reference/*, docs/presentation/*]:
semantic_targets.append(doc){
"tech_stack": {"language": "...", "frameworks": [...]},
"project_root": "...",
"output_dir": "docs/project/.audit/ln-610/{YYYY-MM-DD}"
}{YYYY-MM-DD}2026-03-01mkdir -p {output_dir}| Worker | Invocations | Output |
|---|---|---|
| ln-611-docs-structure-auditor | 1 | |
| ln-612-semantic-content-auditor | N (per target document) | |
| ln-613-code-comments-auditor | 1 | |
| ln-614-docs-fact-checker | 1 | |
doc_pathReport written: ... | Score: X.X/10 | Issues: N (C:N H:N M:N L:N){output_dir}/| Category | Source | Weight |
|---|---|---|
| Documentation Structure | ln-611 | 25% |
| Semantic Content | ln-612 (avg across docs) | 30% |
| Code Comments | ln-613 | 20% |
| Fact Accuracy | ln-614 | 25% |
shared/references/context_validation.mdFOR EACH finding WHERE severity IN (HIGH, MEDIUM):
# Rule 1: ADR/Planned Override
IF finding matches ADR → advisory "[Planned: ADR-XXX]"
# Doc-specific: Compression context (from ln-611)
IF Structure finding Cat 3 (Compression):
- Skip if path in references/ or templates/ (reference docs = naturally large)
- Skip if filename contains architecture/design/api_spec
- Skip if tables+lists > 50% of content (already structured)
# Fact-checker: Example/template path exclusion (from ln-614)
IF Fact finding (PATH_NOT_FOUND):
- Path in examples/ or templates/ directory reference → advisory
- Path has placeholder pattern (YOUR_*, <project>, {name}) → remove
# Fact-checker: Planned feature claims (from ln-614)
IF Fact finding (ENTITY_NOT_FOUND, ENDPOINT_NOT_FOUND):
- Entity mentioned in ADR/roadmap as planned → advisory "[Planned: ADR-XXX]"
# Fact-checker: Cross-doc contradiction authority (from ln-614)
IF Fact finding (CROSS_DOC_*_CONFLICT):
- docs/project/ is authority over docs/reference/ → report reference doc
# Comment-specific: Per-category density targets (from ln-613)
IF Comment finding Cat 2 (Density):
- test/ or tests/ → target density 2-10%
- infra/ or config/ or ci/ → target density 5-15%
- business/domain/services → target density 15-25%
Recalculate with per-category target.
# Comment-specific: Complexity context for WHY-not-WHAT (from ln-613)
IF Comment finding Cat 1 (WHY not WHAT):
- If file McCabe complexity > 15 → WHAT comments acceptable
- If file in domain/ or business/ → explanatory comments OK
Downgraded findings → "Advisory Findings" section in report.docs/project/docs_audit.md## Documentation Audit Report - {DATE}
### Overall Score: X.X/10
| Category | Score | Worker | Issues |
|----------|-------|--------|--------|
| Documentation Structure | X/10 | ln-611 | N issues |
| Semantic Content | X/10 | ln-612 | N issues (across M docs) |
| Code Comments | X/10 | ln-613 | N issues |
| Fact Accuracy | X/10 | ln-614 | N issues |
### Critical Findings
- [ ] **[Category]** `path/file:line` - Issue. **Action:** Fix suggestion.
### Advisory Findings
(Context-validated findings downgraded from MEDIUM/HIGH)
### Recommended Actions
| Priority | Action | Location | Category |
|----------|--------|----------|----------|
| High | ... | ... | ... |shared/references/audit_scoring.mddocs/project/.audit/ln-610/{YYYY-MM-DD}docs/project/docs_audit.mdshared/references/context_validation.mdshared/references/audit_scoring.mdshared/templates/audit_worker_report_template.mdshared/references/task_delegation_pattern.md