documentation-writer

To write Diátaxis-compliant technical documentation, you provide a brief specifying the document type, target audience, user goals, and scope. The process then generates structured Markdown for tutorials, how-to guides, references, or explanations.

In software documentation, a tutorial teaches a novice user how to accomplish a broader goal through guided learning, while a how-to guide provides step-by-step instructions to solve a specific task for users who already know the basics.

To create step-by-step instructions for developer tools, specify a how-to guide document type, define the target audience and scope, and generate Markdown content that includes clear verification steps and troubleshooting tips.

Yes, you can generate API reference documentation and explanations for software projects by specifying the reference or explanation document type in your initial brief, producing accurate and user-centric Markdown output.

To generate a Diátaxis-aligned outline, you need to provide an initial brief specifying the document type, target audience, user goals, and scope. The process proposes a detailed outline and waits for approval before generating full content.

Use a reference document when describing API surfaces and configuration options accurately, and use an explanation document to provide context and clarify design decisions, ensuring your technical writing matches the reader's specific needs.