documentation-writer

Draft Diátaxis documentation across Tutorials, How-to Guides, Reference, and Explanation.

Updated Apr 14, 2026

Search Tags:#workflow #documentation #diataxis #technical-writing #content-creation #documentation-style

Ready to run

npx skills add https://github.com/BrunoAMSilva/my-config --skill documentation-writer-brunoamsilva

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/BrunoAMSilva/my-config/tree/main/coding/skills/documentation-writer
Command: npx skills add https://github.com/BrunoAMSilva/my-config --skill documentation-writer-brunoamsilva

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Diátaxis Documentation Expert streamlines high-quality software documentation by guiding writers through the Diátaxis framework to produce well-structured, consistent docs.

Core Features & Use Cases

Four-quadrant documentation across Tutorials, How-to Guides, Reference, and Explanation.
Guided workflow from clarification to outline to final content, ensuring clarity and consistency.
Reusable templates and checklists to maintain voice and terminology across projects.

Quick Start

Draft comprehensive Diátaxis-style documentation for a chosen topic.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

What is Diátaxis technical writing and how does it structure documentation?▼

Diátaxis technical writing structures documentation across four quadrants: Tutorials, How-to Guides, Reference, and Explanation. It separates content by user intent and learning mode to create clear, targeted software documentation for different developer needs.

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

You write software documentation using a repeatable workflow that starts with clarifying questions, creates outlines, and iteratively generates content. This process ensures consistent voice and terminology while producing explicit frontmatter for each technical document.

Can I use Diátaxis documentation for APIs and technical components?▼

Yes, you can use Diátaxis documentation for APIs and technical components. The workflow supports software projects by drafting comprehensive guides, tutorials, and reference materials tailored to developers, product teams, and technical writers.

What's the best way to maintain consistent terminology across technical documentation?▼

The best way to maintain consistent terminology across technical documentation is using reusable templates and checklists within a guided workflow. This ensures a consistent voice and terminology across all generated Diátaxis content components.

Does technical writing workflow require explicit frontmatter for each document?▼

Yes, this technical writing workflow requires explicit frontmatter for each document. The generated documentation meets strict requirements for frontmatter, consistent voice, and terminology across all four Diátaxis quadrants.