documentation-generator

Purpose

Produce documentation whose source of truth is the code, not a separate document that starts accurate and rots. The input is a codebase, a module, or an API spec; the output is doc comments in the source, a generated reference site, a README, a changelog, or a diagram — plus an honest list of what is still undocumented.

Documentation that is written beside the code drifts within weeks. Documentation derived from the code drifts only when someone changes a signature without changing its comment — which a generator can detect and report. That detection is most of the value here; typing prose is the cheap part.

When to use