documentation-writer

Generate API documentation by analyzing your source code to create module and integration docs, request/response examples, and usage instructions. The tool detects existing documentation gaps and adheres to question-driven structures, code-example mandates, and brevity principles.

Update technical documentation after code changes by running targeted updates on modified components. The process analyzes your codebase to ensure existing docs reflect recent changes, maintaining accuracy across modules, APIs, and integrations without manual rewriting.

Detect missing documentation sections in your codebase using automatic gap detection. The analysis scans source code to identify undocumented modules, APIs, and integrations, then generates the missing technical docs with required code examples and a question-driven structure.

Document a specific module without scanning the entire project by using targeted documentation generation. You can specify a single component, like an auth module, to produce focused module docs, API references, and integration guides based only on that code.

Generated module documentation follows a question-driven structure, code-example mandates, and brevity principles. It analyzes source code to produce concise technical writing that includes necessary API usage instructions and request or response examples for developers.