Saltar al contenido
TakoAPI
Volver a skills

diataxis-writing

por amumulam

Coding Agents & IDEs
256Descargas según clawskills.sh
0Vistas
0 me gustaInicia sesión para dar me gusta a esta skill
—Aún sin valoraciones
Tu valoración

Resumen

Diataxis documentation framework practice guide.

Descripción

Qué hace esta skill

Guides documentation writing using the Diataxis framework, which defines four distinct types: Tutorial, How-to Guide, Reference, and Explanation. Includes a compass tool to classify documents by user need and content type, plus templates, checklists, and quality assessment criteria for each type.

Applies a diagnostic classification step before writing, which prevents the common mistake of mixing content that belongs in separate document types.

Cuándo usarla

  • Deciding whether a troubleshooting record belongs in a how-to guide or an explanation
  • Writing a structured tutorial for onboarding developers to a new codebase
  • Auditing existing docs that mix reference material with conceptual explanations
  • Converting lessons-learned notes or experience summaries into correctly typed documents
  • Checking a draft document against functional and deep quality criteria before publishing

Flujo de trabajo de ejemplo

ENTRADA

User asks: I have a troubleshooting record from a production incident — how should I document it?

AGENTE
  1. 1

    Ask user for language preference and preferred output method

  2. 2

    Use the Diataxis compass to classify: is the content action guidance or cognitive knowledge, and is the reader acquiring or applying skills?

  3. 3

    Determine type — how-to guide if the record is step-by-step resolution, explanation if it analyzes root cause

  4. 4

    Select the troubleshooting template and write the document in the confirmed language

  5. 5

    Apply the relevant checklist and quality framework, then output via the chosen method

SALIDA

A classified, structured document matching the correct Diataxis type, delivered to the user's chosen platform

Instalación

clawhub install amumulam/diataxis-writing

Ejecuta el comando de la CLI o pega el prompt en Claude Code, Cursor, Codex o el agente de programación que uses.

Enlaces