documentation-writer

Generate Diátaxis-compliant documentation across tutorials, how-tos, references, and explanations.

Updated Mar 18, 2026

Search Tags:#documentation #standards #diataxis #technical-writing #content-design #documentation-workflow #audience-focused

Ready to run

npx skills add https://github.com/angryconsultant/Copilot-CLI --skill documentation-writer-angryconsultant

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creates consistent, high-quality technical documentation by applying the Diátaxis framework to four document types, helping teams align tone, structure, and objectives across projects.

Core Features & Use Cases

Diátaxis-aligned output: ensures coverage across Tutorials, How-tos, References, and Explanations.
Frontmatter-driven metadata: standardizes discovery, indexing, and metadata extraction.
Audience-focused writing: adapts content for novice developers, seasoned engineers, and product teams.
Workflow guidance: provides a repeatable process from acknowledgment to outline to final content.

Quick Start

Provide a complete Diátaxis documentation draft for a feature, including a Tutorial, How-to, Reference, and Explanation.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

What is the Diátaxis framework for technical documentation?▼

The Diátaxis framework structures technical documentation into four quadrants: tutorials, how-tos, references, and explanations. This approach aligns content objectives and tone to guide users from initial learning to practical mastery.

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

To write documentation across these four types, you provide a feature context to generate a Diátaxis-compliant draft. The output adapts content for diverse audiences, ensuring practical, actionable guidance with standardized frontmatter metadata.

Does this documentation workflow adapt content for different engineering audiences?▼

Yes, the documentation workflow adapts content for novice developers, seasoned engineers, and product teams. It adjusts the tone and structure to ensure audience-focused writing across all generated technical documentation.

What is the best way to standardize metadata for technical documentation?▼

The best way to standardize metadata is using frontmatter-driven extraction at the top of the document. This ensures consistent discovery and indexing across software projects while maintaining Diátaxis-aligned content structure.

Can I use this to generate a complete documentation outline from a feature description?▼

Yes, you can generate a complete documentation outline from a feature description. The workflow provides a repeatable process from acknowledgment to outline, culminating in final content across the four Diátaxis quadrants.

When should I not use a Diátaxis documentation structure?▼

Diátaxis documentation structure is not suited for projects requiring narrative-driven content or single-page manuals. It is designed for software projects needing strict separation of tutorials, how-tos, references, and explanations across diverse audiences.