documentation-writer

The Diátaxis framework structures technical documentation into four distinct quadrants: tutorials for learning, how-to guides for problem solving, reference material for information, and explanations for understanding. It improves documentation clarity and consistency by matching content to specific user needs.

To create a software tutorial, first elicit the target audience, user goal, and scope from the feature brief. Then propose a detailed step-by-step outline for approval before generating the final Markdown content, ensuring the tutorial emphasizes clarity, accuracy, and consistency for novice users.

Yes, you can generate reference docs and how-to guides for developers and operators. The workflow produces tailored content for each Diátaxis quadrant, ensuring reference material provides concise API and command syntax, while how-to guides focus on solving common practical tasks.

The best way to structure a software documentation style guide is applying the Diátaxis framework to separate content by purpose. This approach transforms vague requests into structured Markdown, distinguishing learning material from problem-solving guides and technical reference docs to improve usefulness.

Yes, the documentation workflow requires an outline approval process. After eliciting document type and scope, it proposes a detailed outline for your review and approval before delivering the final formatted Markdown content, ensuring the generated technical writing meets expectations.