documentation-writer

Guide technical writers in creating Diátaxis-structured software documentation.

Updated Jan 20, 2026

Search Tags:#documentation #technical writing #guides #diataxis #manuals

Ready to run

npx skills add https://github.com/AdrianAVA9/cero-base --skill documentation-writer-adrianava9

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This Skill assists in creating clear, accurate, and user-focused software documentation by leveraging the Diátaxis framework, addressing common challenges faced by technical writers and teams in producing comprehensive guides.

Core Features & Use Cases

Structured Content Creation: Guides users to produce tutorials, how-to guides, references, and explanations aligned with Diátaxis principles.
Workflow Guidance: Helps clarify documentation goals, target audience, scope, and structure before drafting.
Use Case: A developer team uses this Skill to generate consistent, high-quality API documentation that improves onboarding and reduces support queries.

Quick Start

Provide the specific documentation task details and target audience, and the Skill will guide you through creating your content step by step.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

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

To create software documentation using the Diátaxis framework, you structure content into four distinct types: tutorials, how-to guides, references, and explanations. This approach ensures clarity by matching documentation to user needs and project scope.

What is the difference between tutorials and how-to guides in technical writing?▼

In technical writing, tutorials are learning-oriented guides that teach users how to accomplish a task, while how-to guides are problem-oriented directions focused on achieving a specific goal. The Diátaxis framework separates these to ensure documentation accurately serves different user intents.

How do I plan the structure and scope for a software manual?▼

To plan the structure and scope for a software manual, you must first clarify your documentation goals, target audience, and project scope. Defining these elements before drafting ensures your technical communication remains accurate, consistent, and user-focused.

Can I use this approach to write API references and onboarding guides?▼

Yes, you can use this structured approach to write API references and onboarding guides. It guides technical writers through drafting references tailored to user needs, helping developer teams generate consistent API documentation that improves onboarding and reduces support queries.

What is the best way to ensure consistency and accuracy across technical guides?▼

The best way to ensure consistency and accuracy across technical guides is to apply a structured framework like Diátaxis during the drafting process. Planning documentation goals and target audience beforehand maintains high-quality technical communication throughout the project.