ensure-docs

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.

1. Language detection — Follow Phase 1 (language detection) in [references/workflow.md](references/workflow.md).
2. 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.

1. Load standards — Read the sections for your detected languages (language standards, verifier prompts, consolidation format) in the same reference file.
2. Pass: You can state which standard applies per language (e.g. Google docstrings, JSDoc, GoDoc) before spawning agents.

1. Parallel verification — Spawn one verifier per qualifying language using the agent prompts and JSON output shape in the reference (Phase 2).
2. Pass: Each completed agent returns parseable JSON including language, files_scanned, and findings (array, possibly empty).

1. Consolidated report — Merge results per Phase 3 (summary table, severity grouping, detailed findings if requested).
2. Pass: The user sees the merged report (inline or written to an agreed path) before you claim the audit is done or propose fixes.

1. Generation — Only if --report-only is not set: offer choices per Phase 4; apply doc edits only after an explicit user choice to generate.
2. 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.

1. 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.
2. 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-only to skip generation.
• Avoid test files unless they are test helpers.
• Keep report output aligned with the language-specific standards in the reference file.