documentation-writer

Name: documentation-writer
Availability: InStock
Author: tc9011

Generate Diátaxis-framework technical documentation in Markdown.

Updated Feb 5, 2026

Search Tags:#documentation #markdown #technical writing #content generation #tutorials #how-to guides #diataxis

Ready to run

npx skills add https://github.com/tc9011/my-skills --skill documentation-writer-tc9011

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

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.

Core Features & Use Cases

Diátaxis Framework Adherence: Generates documentation following the four core types: Tutorials, How-to Guides, Reference, and Explanations.
Structured Workflow: Guides users through a clear process of clarification, outline proposal, and content generation.
Use Case: A software development team needs to document a new API. This Skill can help generate a comprehensive set of reference documentation, tutorials for common use cases, and how-to guides for specific integration tasks.

Quick Start

Use the documentation-writer skill to create a tutorial for new developers on setting up the project.

Frequently Asked Questions about documentation-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What is the Diátaxis framework for technical documentation?▼

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.

How do I write a tutorial that follows the Diátaxis framework?▼

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.

What's the best way to generate reference documentation for an API?▼

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.

Can I use this approach to create how-to guides for specific integration tasks?▼

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.

Do I need to define the target audience before generating technical documentation?▼

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.

When should I use an explanation versus a how-to guide in technical writing?▼

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.