document-generate

To generate structured documentation for a feature, you can use an automated approach based on the Diataxis framework. This process reads your project files and outputs comprehensive coverage for features, modules, or entire projects without manual writing.

The Diataxis framework is used to structure project documentation into tutorials, how-to guides, reference, and explanation. Applying it to automated generation ensures your technical docs have complete, logical coverage from scratch.

Yes, you can automatically create documentation from scratch for an entire module. The automation scans your codebase using file reading and search tools, then writes structured documentation to fill coverage gaps.

The best way to update existing documentation for a new feature is to trigger an automated generation workflow. This ensures consistent structure and comprehensive coverage by applying the Diataxis framework to the updated codebase.

Automated documentation generation works without manual file searches by utilizing integrated search, read, and write tools. It autonomously locates and processes the necessary codebase files to produce the final structured documentation output.

You should not use automated documentation generation when you require highly narrative, opinionated, or custom-formatted documentation. This approach specifically applies the Diataxis framework structure, which may not suit all arbitrary formatting preferences.