documentation-writer

Technical documentation using the Diátaxis framework is structured into four distinct quadrants: task-oriented tutorials, step-by-step how-to guides, concise reference material, and explanatory articles. This approach ensures content meets specific reader goals.

The best way to write a contributor onboarding tutorial is to follow a structured authoring workflow that clarifies audience and scope, proposes an outline for approval, and generates final Markdown documentation tailored to your project's existing tone.

Yes, you can generate how-to guides and API reference pages in Markdown format. The documentation workflow produces final Markdown documentation adhering to Diátaxis principles for both developer and end-user audiences.

To create a documentation outline for approval, the workflow guides you through clarifying audience, scope, and user goals first, then produces a proposed outline for your review before generating the final Markdown documentation.

You need to separate tutorials from reference material when addressing different reader goals, such as learning versus looking up specific information. The Diátaxis framework eliminates unfocused documentation by matching content types to these distinct learning modes.