Vai al contenuto
TakoAPI
Torna alle skill

diataxis-writing

di amumulam

Coding Agents & IDEs
256Download riportati da clawskills.sh
0Visualizzazioni
0 likeAccedi per mettere like a questa skill
—Non ancora valutato
La tua valutazione

Sintesi

Diataxis documentation framework practice guide.

Descrizione

Cosa fa questa 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.

Quando 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

Esempio di workflow

INPUT

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

AGENT
  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

OUTPUT

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

Installazione

clawhub install amumulam/diataxis-writing

Esegui il comando CLI oppure incolla il prompt in Claude Code, Cursor, Codex o nell'agente di coding che usi.

Link