documentation-writer

The Diátaxis framework structures software documentation into four distinct types: tutorials, how-to guides, reference material, and explanations. This approach ensures clarity and purpose-driven content by separating learning from practical application.

To generate Diátaxis documentation, provide your software project information, target audience details, and desired document scope. The tool then asks targeted questions, proposes an outline for approval, and drafts the structured markdown output.

Yes, you can supply existing markdown files for context-aware writing. The tool utilizes these files to match your project's tone and terminology without copying content, ensuring the generated reference manuals align with your documentation style.

The best way to structure reference manuals and explanations is applying the Diátaxis framework, which separates practical guides from theoretical understanding. This ensures consistent, purpose-driven documentation tailored to your specific target audience.

Yes, you need to define the target audience and document scope before generation. The tool requires clear project information and audience details to produce accurate, consistent markdown output that fits the specific needs of your users.