Spell Doc Audit
## Summary
**Analyze existing documentation for gaps, mixed concerns, and structural issues.** Applies three lenses: Diataxis (purpose classification), progressive disclosure (depth layering), and ROT analysis (content quality). Read-only — produces an audit report, not file changes.
**Arguments:** `$ARGUMENTS` (required) - Path to docs directory or files to audit
**Output:** Structured audit report with inventory, coverage analysis, and prioritized recommendations output directly to the conversation
---
## Skill References
Before proceeding, load the relevant skill documents for reference:
Read the following files from the repository root:
- `docs/skills/diataxis-framework.md`
- `docs/skills/progressive-disclosure-framework.md`
---
## Process
### Step 1: Inventory (Quantitative)
Find all markdown files in the target path. Read each file.
Build a content inventory:
- File count, total lines, average lines per file
- File names and paths
- Which files link to which (inbound/outbound link map)
**If `$ARGUMENTS` is empty:**
Ask the user what documentation path to audit.
**If no markdown files found:** Report "No documentation found at this path" and stop.
**Output the inventory:**when to use it
Community prompt sourced from the open-source GitHub repo smileynet/sams-genai-spells (MIT). A "Spell Doc Audit" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
roleplaycommunitygeneral
source
smileynet/sams-genai-spells · MIT