Document Generate

Document Generate creates missing documentation for a codebase from the implementation up. It is for greenfield documentation coverage, not small doc touch-ups.

The organizing frame is Diataxis:

• Tutorial - get to a first successful result
• How-to - complete a specific task
• Reference - factual interface details
• Explanation - why the design works this way

When to Use

• A shipped feature has little or no documentation
• A module or subsystem needs first-pass docs from the source code
• A project needs documentation coverage beyond one README paragraph
• You need to decide which entities deserve tutorial, how-to, reference, and explanation docs