Lewati ke konten
TakoAPI
Kembali ke skill

diataxis-writing

oleh amumulam

Coding Agents & IDEs
256Unduhan dilaporkan oleh clawskills.sh
0Tayangan
0 sukaMasuk untuk menyukai skill ini
—Belum ada penilaian
Penilaian Anda

Ringkasan

Diataxis documentation framework practice guide.

Deskripsi

Apa yang Dilakukan Skill Ini

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.

Kapan Menggunakannya

  • 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

Contoh Alur Kerja

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

Instalasi

clawhub install amumulam/diataxis-writing

Jalankan perintah CLI-nya, atau tempel prompt ke Claude Code, Cursor, Codex, atau coding agent apa pun yang Anda pakai.

Tautan