documentation-writer

The best way to structure technical writing is using the Diátaxis framework, which categorizes content into tutorials, how-to guides, reference material, and explanations to serve specific user learning needs.

To write a how-to guide, first clarify the document type, target audience, and scope, then generate an outline for approval before producing consistent Markdown focused on the specific task goal.

You need to separate tutorials from reference documentation when users have different goals: tutorials serve learning through practice, while reference documentation serves information lookup for specific configurations or flags.

Yes, you can generate both reference and explanation docs by specifying your desired document types, audience, and scope, which prompts a clarification workflow to produce consistent Markdown mapped to those Diátaxis categories.

Yes, the approach requires an outline before generating full documentation, ensuring the document type, audience, goal, and scope are reviewed and approved to prevent irrelevant or incomplete content.

You should use Diátaxis over unstructured technical writing because it aligns each document with a distinct user purpose, preventing vague content and ensuring tutorials, how-to guides, reference, and explanations meet specific comprehension needs.