documentation-writer

The Diátaxis framework structures software documentation into Tutorials, How-to Guides, Reference materials, and Explanations. It aligns content with user goals for learning, problem-solving, reference, and understanding.

Generate API reference documentation in Markdown through a structured workflow of clarification, outline proposal, and content generation. This produces reference materials tailored to specific user needs and target audiences.

Write tutorials for new developers by specifying learning goals and target audiences. The generation process creates Markdown tutorials aligned with Diátaxis principles to guide users step-by-step.

In Diátaxis, Tutorials focus on learning by guiding beginners through practical steps, while How-to Guides focus on achieving specific goals for users who know the basics. Both are generated as Markdown content.

Create developer guides for different target audiences by specifying user goals during the clarification step. The workflow generates tailored Markdown content suited for varying technical levels and needs.

Automated documentation generation works for explaining core concepts by producing the Explanation document type from the Diátaxis framework. It generates Markdown content that deepens understanding of specific technical topics.