Zum Inhalt springen
TakoAPI
Zurück zu den Skills

diataxis-writing

von amumulam

Coding Agents & IDEs
256Downloadzahlen laut clawskills.sh
0Aufrufe
0 LikesMelde dich an, um diesen Skill zu liken
—Noch nicht bewertet
Deine Bewertung

Kurzbeschreibung

Diataxis documentation framework practice guide.

Beschreibung

Was dieser Skill macht

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.

Wann du ihn einsetzt

  • 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

Beispiel-Workflow

EINGABE

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

AUSGABE

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

Installation

clawhub install amumulam/diataxis-writing

Führe den CLI-Befehl aus oder füge den Prompt in Claude Code, Cursor, Codex oder deinen Coding-Agenten ein.

Links