compile-docs

Technical documentation writer that produces clear, complete reference pages from a microplan. Use this agent when you need to write or update documentation pages. <example> Write documentation for jq built-in functions from a microplan. <commentary>The orchestrator delegates with the microplan path. The author reads the style guide, follows the microplan's content instructions, and writes each function entry with `jq` usage examples and `[Source: ...]` citations.</commentary> </example> <example> Revise jq flag documentation after editor feedback. <commentary>The orchestrator delegates with the microplan and an issues file path. The author reads each issue, cross-references the style guide, updates flag entries using `jq --help` output where needed, and resolves every flagged item.</commentary> </example>

Senior technical editor that reviews completed documentation for quality, consistency, and completeness. Use this agent when you need to review completed documentation for quality, consistency, and completeness. <example> Review jq built-in function documentation for style guide compliance and completeness. <commentary>The orchestrator delegates with the doc file paths, style guide path, and output path. The editor reads every page, checks each section against the style guide, verifies `jq` examples and citations, and writes an issues file with severity-tiered findings.</commentary> </example> <example> Cross-check jq flag documentation against the reference inventory for missing entries. <commentary>The orchestrator delegates with the inventory, hierarchy plan, and doc paths. The editor compares inventory entries to documented flags, identifies gaps, checks `jq --help` citations, and writes an issues file noting missing coverage as Critical and formatting inconsistencies as Style.</commentary> </example>

Documentation architect that designs file and directory hierarchies from a reference inventory. Use this agent when you need to design the documentation file/directory structure from a reference inventory. <example> Design the docs layout for a jq built-in functions inventory. <commentary>The orchestrator delegates with the inventory path. The planner reads it, groups entries by category, designs a directory tree, and writes a hierarchy plan with `jq`-friendly file naming conventions.</commentary> </example> <example> Plan the file structure for a large CLI tool with nested subcommands. <commentary>The planner reads the inventory, identifies command groups, designs index pages per group, maps every entry to an output file using `jq`-style depth-first ordering, and writes the plan.</commentary> </example>

Systematically enumerates every entry in reference material and produces a complete structured inventory. Use this agent when you need to enumerate every entry in reference material and produce a complete inventory. <example> Enumerate all top-level keys and nested structures in a JSON API response. <commentary>The orchestrator delegates with a scouting report. The explorer uses `jq` to walk every key, discovers nested arrays, and writes a full inventory file.</commentary> </example> <example> Catalog every command and subcommand in a CLI tool's help output. <commentary>The explorer runs each command with `--help`, pipes through `jq` where output is JSON, recurses into subcommands, and writes numbered inventory files if the set is large.</commentary> </example>

Reconnaissance agent that maps the structure and navigation method of reference material before documenting it. Use this agent when you need to discover the structure and navigation method of reference material before documenting it. <example> User asks to document all jq built-in functions. Delegate to reference-scout to discover how jq organizes its reference material (man page sections, web manual TOC, --help output) before sending reference-explorer to extract each entry. </example> <example> User asks to catalog jq's command-line flags and options. Delegate to reference-scout to probe `jq --help` and the jq manual page, map the flag categories, and recommend the best traversal strategy for reference-explorer. </example>

Use when compiling documentation for a CLI tool, API, or other system from its reference material.