write-docs

Classify documentation requests into Diátaxis quadrants before writing.

Updated Mar 2, 2026
One-click install
npx skills add https://github.com/smp4/claude-skills --skill write-docs-smp4
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/smp4/claude-skills/tree/main/dot_claude/skills/write-docs
Command: npx skills add https://github.com/smp4/claude-skills --skill write-docs-smp4

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation requests often mix tutorials, how-tos, and explanations, which leads to inconsistent structure, tone, and wasted reviewer time; this skill forces Diátaxis detection and an explicit quadrant before writing so every doc stays focused on the reader's goal.

Core Features & Use Cases

  • Diátaxis detection: Scan ~/.claude/CLAUDE.md, project-level CLAUDE.md, and project docs to confirm whether the framework is used before writing, then ask the user for clarification if no trace appears.
  • Explicit quadrant response: Declare the quadrant and the reasoning, and prompt for separate documents when a request spans more than one quadrant so the output never mixes tutorial, how-to, and explanation content.
  • Style enforcement: Follow the rules from references/diataxis.md and references/style.md to keep the voice, structure, and formatting consistent whether you are improving a README, drafting a quick guide, or critiquing existing documentation.

Use this skill whenever a teammate asks for any technical documentation so the result matches the intended quadrant and stays within the documented rules.

Quick Start

Confirm the request's quadrant and explain the reasoning before writing any documentation.

Frequently Asked Questions about write-docs

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

FAQPage Schema
When do I need to split a documentation request into separate guides?

You need to split a documentation request into separate guides when the prompt spans more than one Diataxis quadrant. Detecting mixed tutorial, how-to, and explanation content requires prompting for separate documents to prevent structural inconsistency.

How do I enforce Diataxis framework classification when writing technical documentation?

To enforce Diataxis classification when writing technical documentation, you must declare an explicit quadrant and reasoning before drafting. This prevents mixed-messaging outputs by ensuring every tutorial, how-to, or explanation stays focused on the reader's specific goal.

Why does my developer documentation mix tutorials and explanations inconsistently?

Developer documentation mixes tutorials and explanations inconsistently because requests often span multiple Diataxis quadrants. You must detect the intended quadrant first and prompt for separate documents to keep structure, tone, and voice focused.

What is the best way to structure a README using Diataxis quadrants?

The best way to structure a README using Diataxis quadrants is to scan existing project docs for framework usage, explicitly declare the target quadrant, and apply defined style guidelines to maintain consistent voice and formatting throughout the document.

Can I use Diataxis to review and improve existing technical writing?

Yes, you can use Diataxis to review and improve existing technical writing by detecting the current quadrant classification, evaluating the content against style guidelines, and restructuring mixed-messaging sections into focused documentation.

When do I need to split a documentation request into separate guides?

You need to split a documentation request into separate guides when the prompt spans more than one Diataxis quadrant. Detecting mixed tutorial, how-to, and explanation content requires prompting for separate documents to prevent structural inconsistency.