Generate Diátaxis-framework technical documentation in Markdown.
npx skills add https://github.com/tc9011/my-skills --skill documentation-writer-tc9011
Please help me install this Agent Skill. Skill: documentation-writer Source: https://github.com/tc9011/my-skills/tree/main/skills/documentation-writer Command: npx skills add https://github.com/tc9011/my-skills --skill documentation-writer-tc9011
This Skill addresses the challenge of creating high-quality, structured technical documentation by adhering to the Diátaxis framework, ensuring clarity, accuracy, and user-centricity.
Use the documentation-writer skill to create a tutorial for new developers on setting up the project.
High-intent search queries and answers about installing and using this skill.
The Diátaxis framework structures technical documentation into four distinct types: tutorials, how-to guides, reference materials, and explanations, ensuring content is user-centric and clearly separated by purpose.
To write a tutorial, you provide the document type, target audience, user goal, and scope. The skill then proposes a structure and generates Markdown content aligned with the Diátaxis learning-oriented tutorial standard.
Generating API reference documentation works best by specifying your target audience and scope, allowing the skill to produce structured Markdown reference materials that strictly adhere to the Diátaxis framework.
Yes, you can create how-to guides by clarifying the specific integration task and user goal. The skill generates practical, goal-oriented Markdown guides following the Diátaxis documentation structure.
Yes, you must clarify the document type, target audience, user goal, and scope before content generation begins, ensuring the resulting Markdown documentation accurately addresses the specific needs of that audience.
Use explanations to clarify concepts and design choices, and how-to guides to solve specific problems. The Diátaxis framework separates these to prevent mixing theoretical understanding with practical steps.
cajiasCreate structured technical documentation aligned with the Diátaxis framework.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.
JongsixGenerate technical documentation from source code and API definitions.
alextiannusResearch topics and generate outlines and drafts for blog posts and marketing copy.
