documentation-writer

Create Diátaxis-aligned documentation across tutorials, how-tos, references, and explanations.

1|Updated Apr 29, 2026
One-click install
npx skills add https://github.com/firstsun-dev/yao-agent-skills --skill documentation-writer-firstsun-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/firstsun-dev/yao-agent-skills/tree/main/external/basic/documentation-writer
Command: npx skills add https://github.com/firstsun-dev/yao-agent-skills --skill documentation-writer-firstsun-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a structured, Diátaxis-compliant approach to creating high-quality software documentation across four document types (Tutorials, How-tos, Reference, and Explanation), enabling teams to produce consistent, user-centered content.

Core Features & Use Cases

  • Diátaxis-aligned documentation design framework for software projects.
  • Guided workflows for planning, drafting, reviewing, and maintaining docs.
  • Use Case: A team creating API documentation to ship tutorials, reference sections, and explanations.

Quick Start

Start by clarifying the target audience and documentation goals, then outline a four-quadrant documentation plan and generate the draft content.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
What is Diátaxis documentation and how does it structure technical content?

Diátaxis documentation is a framework that structures technical content into four distinct types: tutorials, how-tos, references, and explanations. This approach separates learning-oriented material from practical guidance and reference data to improve user comprehension.

How do I write technical documentation that covers tutorials, how-tos, and references?

To write technical documentation across these formats, define your target audience and project goals first, then outline a four-quadrant documentation plan to generate structured drafts with consistent voice, frontmatter metadata, and aligned terminology.

Can I use the Diátaxis framework for API reference documentation?

Yes, the Diátaxis framework supports API reference documentation by separating practical how-to guides and reference sections from conceptual explanations, ensuring technical writers and developers produce consistent, user-centered API content.

What is the best way to plan a documentation strategy for a software project?

The best way to plan a documentation strategy is to clarify your audience and goals, then map content across the four Diátaxis quadrants to ensure comprehensive coverage of tutorials, how-tos, references, and explanations with a practical structure.

Does this documentation writing approach require existing project terminology?

Yes, aligning with the project's existing tone and terminology is required to ensure the generated tutorials, how-tos, reference sections, and explanations maintain a consistent voice across all four documentation types.