documentation-writer

The Diátaxis framework structures technical documentation into Tutorials, How-to Guides, Reference, and Explanation. You can generate content for these four types by defining the document type, target audience, user goal, and scope before creating an outline.

In technical writing, a tutorial teaches beginners how to accomplish a learning goal, while a how-to guide shows experienced users how to complete a specific task. This Skill generates both by requiring you to define the document type and target audience beforehand.

To generate a tutorial for a new API endpoint, specify junior developers as the target audience, define the user goal, and set the scope. The Skill will propose a structured outline and generate user-centric content based on those parameters.

No, you do not need to provide an outline before generating documentation. You must define the document type, target audience, user goal, and scope, and the Skill will propose an outline for your approval before generating the final content.

The best way to structure reference documentation is to follow the Diátaxis framework, focusing on accuracy and clarity. By defining your API endpoints as the scope, the Skill generates structured reference material oriented around the user's needs.

Yes, you can generate explanations of underlying concepts by selecting the Explanation document type within the Diátaxis framework. You need to define the target audience and scope to produce clear, user-centric conceptual documentation.