skills.rest
Yassimba
YassimbaCOMMUNITY
Explore all skills by this author →
GitHub

write-documentation

Write software documentation structured by the Diátaxis framework.

9|Updated Jul 17, 2026
Search Tags:#documentation#technical writing#reference#explanation#tutorial#diataxis#how-to guide
One-click install
npx skills add https://github.com/Yassimba/loom --skill write-documentation-yassimba
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-documentation
Source: https://github.com/Yassimba/loom/tree/main/skills/write-documentation
Command: npx skills add https://github.com/Yassimba/loom --skill write-documentation-yassimba

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation requests often mix tutorials, how-to guides, reference material, and explanations into one muddled page. This Skill classifies each request into the correct Diátaxis quadrant and produces a single, well-structured document that serves one clear reader need. ## Core Features & Use Cases - Diátaxis Classification: Places each request on the action/cognition and acquisition/application compass to determine whether it is a tutorial, how-to guide, reference, or explanation. - Quadrant-Specific Rules: Loads dedicated rule files for each document type covering structure, language, scope boundaries, and completion criteria. - Brief Confirmation and Outline Approval: Confirms audience, reader goal, and scope before writing, then proposes an outline for approval. - Use Case: A user asks to document a new CLI tool. The Skill classifies the request as a how-to guide, confirms the audience of competent developers, proposes an outline, and writes a goal-oriented guide verified against the actual codebase. ## Quick Start Use the write-documentation skill to write a how-to guide for configuring the authentication module.

Frequently Asked Questions about write-documentation

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

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

Classify the request on two axes: action versus cognition, and acquisition versus application. This yields a tutorial, how-to guide, reference, or explanation. Then confirm audience, goal, and scope, load the matching quadrant rules, propose an outline, and write the full document.

What is the difference between a tutorial and a how-to guide?▼

A tutorial is a lesson for a newcomer acquiring skill through guided action, while a how-to guide is a recipe helping an already-competent reader achieve a specific real-world result. Tutorials serve study; how-to guides serve work.

When should I use reference documentation instead of explanation?▼

Use reference when the reader needs authoritative technical description of the product's machinery during work, such as APIs, commands, and configuration. Use explanation when the reader needs reflective discussion of context, design decisions, and trade-offs.

Can this skill write READMEs or docstrings?▼

No. The skill explicitly excludes READMEs, which belong to the write-readme skill, and docstrings, which belong to the update-docstrings skill. It produces one Diátaxis-typed document per run: tutorial, how-to guide, reference, or explanation.

How do I fix documentation that mixes multiple content types?▼

Use the compass reference to classify what each sentence or section actually serves, then separate the needs into linked documents. Choose one primary quadrant for the current document and move the remaining material to its corresponding type.

Related Skills

Explore More Content & Communication Skills→
Asharf30Asharf30

docs-guard

Cross-reference documentation claims against source code implementations.

Community
Advanced
YusukeShimizuYusukeShimizu
2

lcp-mintlify-docs

Validate Mintlify docs structure, links, and accessibility with docs/scripts/check-docs-json.mjs.

Community
Intermediate
vh2224vh2224
1

write-docs

Gather context, refine outlines, and test documentation drafts for fresh readers.

Community
Intermediate
Arete-ConsortiumArete-Consortium
4

api-docs

Generates Markdown or OpenAPI documentation from source code docstrings and type annotations.

Official
Intermediate