- name
- ensure-docs
- description
- Verify documentation coverage and generate missing docs interactively
- disable-model-invocation
- true
Ensure Documentation Coverage
Verify documentation coverage across a codebase, report gaps, and generate missing docs with parallel language-specific agents.
Workflow
Complete steps in order. Do not advance until each step’s Pass is satisfied.
- Language detection — Follow Phase 1 (language detection) in
references/workflow.md.
- Pass: For each language you will verify, you have evidence of at least one matching source file (counts or command output); if none qualify, stop with a short “no applicable languages” message and do not spawn verifiers.
- Load standards — Read the sections for your detected languages (language standards, verifier prompts, consolidation format) in the same reference file.
- Pass: You can state which standard applies per language (e.g. Google docstrings, JSDoc, GoDoc) before spawning agents.
- Parallel verification — Spawn one verifier per qualifying language using the agent prompts and JSON output shape in the reference (Phase 2).
- Pass: Each completed agent returns parseable JSON including language, files_scanned, and findings (array, possibly empty).
- Consolidated report — Merge results per Phase 3 (summary table, severity grouping, detailed findings if requested).
- Pass: The user sees the merged report (inline or written to an agreed path) before you claim the audit is done or propose fixes.
- Generation — Only if
--report-onlyis not set: offer choices per Phase 4; apply doc edits only after an explicit user choice to generate.
- Pass: No documentation edits for gaps until the user selects an option that includes generation; if they decline or choose report-only behavior, end after the report.
- Post-edit verification — After any generation, run or offer the linter commands in Phase 5 of the reference for languages you changed, when those tools exist in the repo.
- Pass: Linter run completed with output captured, or N/A with a one-line reason (e.g. tool not configured); remaining issues are listed or cleared.
Notes
- Use
--report-onlyto skip generation. - Avoid test files unless they are test helpers.
- Keep report output aligned with the language-specific standards in the reference file.