Generate Diátaxis-compliant software documentation in Markdown.
npx skills add https://github.com/compozy/agh --skill documentation-writer-compozy
Please help me install this Agent Skill. Skill: documentation-writer Source: https://github.com/compozy/agh/tree/main/.agents/skills/documentation-writer Command: npx skills add https://github.com/compozy/agh --skill documentation-writer-compozy
It helps you produce clear, accurate, and user-focused software documentation by matching content to the right Diátaxis document type so readers can learn, solve problems, look things up, or understand concepts efficiently.
Use case example: You need onboarding materials for a new AGH feature, a step-by-step guide to perform a common setup task, a reference page describing CLI options, and an explanation of how the underlying concept works.
Ask the skill to create a Diátaxis Tutorial for the documentation of a new feature, including the target audience, the user’s goal, and what should be in or out of scope.
High-intent search queries and answers about installing and using this skill.
The Diátaxis framework structures technical documentation into four types—Tutorials, How-to Guides, Reference, and Explanations—each serving a distinct reader intent like learning, problem-solving, or lookup. This approach matches content to user goals efficiently.
To write a Diátaxis-compliant tutorial, specify the target audience, the user's learning goal, and the scope. The skill clarifies these elements, proposes a structure for approval, then generates Markdown content with consistent terminology and tone.
Use a how-to guide when the reader needs step-by-step instructions to solve a specific problem, and use an explanation when they need to understand underlying concepts. The skill selects the appropriate Diátaxis document type based on the requested user goal.
Yes, you can generate reference documentation for CLI options. The skill treats reference material as a distinct Diátaxis type, requiring you to define the audience and scope before producing accurate, lookup-focused Markdown content.
No specific platform or framework is required. The skill operates independently to produce Markdown content, requiring only the document type, audience, goal, and scope to draft Diátaxis-compliant software documentation.
cajiasCreate structured technical documentation aligned with the Diátaxis framework.
JongsixGenerate technical documentation from source code and API definitions.
garochee33Generate READMEs, API references, and code comment standards from source code.
wahidyankfCategorize technical documentation into Diátaxis types and map them to directories.
