documentation-writer

Organize software documentation into tutorials, guides, references, and explanations.

2|2|Updated Jul 1, 2025

Search Tags:#documentation #writing #structure #software #diataxis #technical-writing

Ready to run

npx skills add https://github.com/Rafaelp122/wedding_management --skill documentation-writer-rafaelp122

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Diátaxis Documentation Expert helps teams craft high-quality software documentation by applying a consistent, principle-driven framework.

Core Features & Use Cases

Supports tutorials, how-to guides, references, and explanations using Diátaxis structure.
Provides templates and style guidance to ensure consistent voice, tone, and terminology across docs.
Facilitates rapid-start drafting by outlining documentation artifacts from product specs and APIs.

Quick Start

Draft a complete documentation outline by applying the Diátaxis model to your API article.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

What is the Diataxis framework for software documentation?▼

The Diataxis framework is a documentation structure that separates content into tutorials, how-to guides, reference materials, and explanations. It ensures documentation serves distinct user needs by matching learning, doing, and understanding modes.

How do I structure technical writing for an API?▼

Structure API technical writing by applying the Diataxis framework to separate tutorials, how-to guides, and reference materials. This approach uses structured section templates and frontmatter metadata to produce clear, consistent documentation artifacts.

What's the best way to draft a documentation outline from product specs?▼

Draft documentation outlines from product specs by applying the Diataxis model to map features to tutorials, references, and explanations. This ensures consistent voice, terminology, and structured sections across all generated documentation artifacts.

Can I use this approach for both tutorials and reference materials?▼

Yes, the Diataxis documentation approach explicitly supports tutorials, how-to guides, reference materials, and explanations. It applies structured section templates and consistent voice guidance across all these technical writing formats.

How do I maintain a consistent voice across multiple software documentation pages?▼

Maintain consistent voice across software documentation by using structured section templates and style guidance provided by the Diataxis framework. This enforces consistent terminology, tone, and formatting across all documentation artifacts.

When should I not use Diataxis for technical writing?▼

Diataxis is not ideal for technical writing that blends learning and reference into a single narrative. It strictly separates tutorials, how-to guides, references, and explanations, which may not suit projects needing unstructured or conversational documentation.