documentation-writer

Create software documentation structured across the four Diátaxis quadrants.

Updated Mar 27, 2026

Search Tags:#documentation #diataxis #technical-writing #api-docs #content-strategy #developer-docs #tone-consistency

Ready to run

npx skills add https://github.com/sagnick11tib/StackLab --skill documentation-writer-sagnick11tib

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps writers produce high-quality software documentation guided by the Diátaxis framework, ensuring consistency and clarity across tutorials, how-tos, references, and explanations.

Core Features & Use Cases

Diátaxis-guided content planning and structuring for four documentation quadrants.
Consistent tone, terminology, and style across API references, developer guides, and system overviews.
Real-world applicability including API docs, architecture notes, and onboarding tutorials.

Quick Start

Provide a complete, four-quadrant documentation draft for a new API following the Diátaxis framework.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

How do I structure software documentation using the Diátaxis framework?▼

The Diátaxis framework structures software documentation into four distinct quadrants: tutorials, how-to guides, references, and explanations. This approach ensures clarity, accuracy, and user-centric guidance by separating learning material from practical steps and technical descriptions.

What is the best way to write API references and developer guides with consistent tone?▼

Writing API references and developer guides requires consistent tone, terminology, and style across all content. Applying a structured content strategy ensures technical accuracy and clarity across architectural overviews, onboarding tutorials, and developer documentation.

Can I generate all four Diátaxis documentation quadrants for a new API at once?▼

Yes, you can generate a complete four-quadrant documentation draft for a new API following the Diátaxis framework. This includes producing API references, developer guides, and architectural overviews categorized into tutorials, how-tos, references, and explanations.

When do I need to separate tutorials and how-to guides in technical writing?▼

Separating tutorials and how-to guides is needed when following the Diátaxis framework to ensure user-centric guidance. Tutorials focus on learning, while how-to guides address specific practical tasks, maintaining clarity and accuracy across developer docs.

Does the Diátaxis framework work for architectural overviews and system explanations?▼

Yes, the Diátaxis framework works effectively for architectural overviews and system explanations. It categorizes these as explanation-oriented content, ensuring clarity and consistent terminology while discussing design decisions and system architecture alongside API references.

Why does my developer documentation lack clarity and consistent terminology across guides?▼

Developer documentation lacks clarity when it mixes learning, practical steps, and technical references without a content strategy. Applying the Diátaxis framework separates these concerns, ensuring tone consistency and accuracy across all software docs.