documentation-writer

Name: documentation-writer
Availability: InStock
Author: tamago0224

Generate structured software documentation in markdown using the Diátaxis framework.

Updated Mar 8, 2026

Search Tags:#documentation #reference #how-to #explanation #tutorial #diátaxis #technical-writing

Ready to run

npx skills add https://github.com/tamago0224/kuroshio-mta --skill documentation-writer-tamago0224

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/tamago0224/kuroshio-mta/tree/main/.agents/skills/documentation-writer
Command: npx skills add https://github.com/tamago0224/kuroshio-mta --skill documentation-writer-tamago0224

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates the need to manually structure and write software documentation by guiding the author through the Diátaxis framework, ensuring clarity, consistency, and purpose‑driven content.

Core Features & Use Cases

Four‑quadrant workflow: Generates tutorials, how‑to guides, reference material, and explanations according to Diátaxis principles.
Interactive clarification: Asks targeted questions about document type, audience, goal, and scope before drafting.
Outline proposal: Offers a detailed table of contents for approval, streamlining the writing process.
Context‑aware writing: Utilizes supplied markdown files to match the project’s tone and terminology without copying content.

Quick Start

Ask the documentation-writer skill to draft a tutorial for setting up Kuroshio MTA.

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 software documentation?▼

The Diátaxis framework structures software documentation into four distinct types: tutorials, how-to guides, reference material, and explanations. This approach ensures clarity and purpose-driven content by separating learning from practical application.

How do I generate a how-to guide or tutorial using the Diátaxis framework?▼

To generate Diátaxis documentation, provide your software project information, target audience details, and desired document scope. The tool then asks targeted questions, proposes an outline for approval, and drafts the structured markdown output.

Can I use existing markdown files to match my project's tone when writing technical documentation?▼

Yes, you can supply existing markdown files for context-aware writing. The tool utilizes these files to match your project's tone and terminology without copying content, ensuring the generated reference manuals align with your documentation style.

What is the best way to structure reference manuals and explanations for a software project?▼

The best way to structure reference manuals and explanations is applying the Diátaxis framework, which separates practical guides from theoretical understanding. This ensures consistent, purpose-driven documentation tailored to your specific target audience.

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

Yes, you need to define the target audience and document scope before generation. The tool requires clear project information and audience details to produce accurate, consistent markdown output that fits the specific needs of your users.