documentation-writer

To write technical documentation matched to your audience, define the document type, target user goal, and scope before drafting. Using the Diátaxis framework ensures content aligns correctly as a tutorial, how-to guide, reference, or explanation.

The Diátaxis framework is a structured approach to software documentation that categorizes content into tutorials, how-to guides, references, and explanations. You need it when planning technical docs to ensure each piece serves its specific user purpose.

To create a how-to guide for experienced developers, specify the target audience, user goal, and scope. The documentation-writer proposes a detailed outline for approval before generating the full instructional document.

The best way to structure a software reference document is using the Diátaxis framework, which separates references from explanations and tutorials. This ensures the documentation is accurate, user-centered, and formatted for its intended scope.

Yes, you need to define the document type, target audience, user goal, and scope before generating technical documentation. This clarification-first workflow ensures the output is accurate and user-centered before any drafting begins.

Technical documentation lacks a clear purpose when it mixes different intents without a framework. Applying Diátaxis separates tutorials, how-to guides, references, and explanations, reducing confusion by matching format to the user's specific need.