Docs Audit — Monorepo-Wide Documentation Audit
Audit documentation health across all modules in the monorepo and produce an aggregate compliance report.
Command
/docs-audit [--modules-dir <path>] [--format summary|detailed] [--include-root]
Arguments
| Argument | Required | Description |
|---|---|---|
--modules-dir <path> |
No | Root directory containing modules (default: packages or value from config) |
--format |
No | Output format: summary (default) or detailed |
--include-root |
No | Also validate the repo-level docs/ structure |
Workflow
Parse arguments. Extract options from
$ARGUMENTS. Use defaults from project configuration where not specified.Discover modules. Find all subdirectories under the modules directory that appear to be modules (contain a
docs/directory,README.md, orCLAUDE.md).- Filter out modules matching
ignoredModulesglob patterns from project config.
- Filter out modules matching
Determine module types. For each discovered module:
- Read the module's
CLAUDE.mdand look for the## Module Typesection - If not found, use
defaultModuleTypefrom project config - If neither available, report the module as "unknown type" and skip validation
- Read the module's
Validate each module. For each module with a known type, run the structural validation:
bash <plugin-root>/skills/scaffold/scripts/validate-structure.sh \ --module-path <module-path> --type <type>Capture the results (present, missing, placeholder counts).
Validate root (if
--include-root). Run:bash <plugin-root>/skills/scaffold/scripts/validate-structure.sh --rootAggregate results. Compute:
- Total modules scanned
- Modules passing vs. failing
- Compliance rate (percentage)
- Most common gaps across all modules
Format output. Based on
--format:- summary: High-level statistics, common gaps, list of failing modules
- detailed: Per-module breakdown (same format as
/validate) plus summary
See
reference/report-format.mdfor the complete output specification.
Configuration
The audit skill respects project-level configuration from .claude/settings.json:
| Setting | Used For |
|---|---|
modulesDirectory |
Default modules directory if --modules-dir not specified |
defaultModuleType |
Fallback module type if CLAUDE.md doesn't declare one |
ignoredModules |
Glob patterns for modules to skip |
strictMode |
If true, placeholder-only files are treated as failures |
Reference
reference/report-format.md— Complete specification of the audit output format
Converted and distributed by TomeVault — claim your Tome and manage your conversions.