Перейти к содержимому
TakoAPI
Назад к навыкам

diataxis-writing

от amumulam

Coding Agents & IDEs
256Число загрузок по данным clawskills.sh
0Просмотры
0 лайковВойдите, чтобы поставить лайк навыку
—Ещё нет оценок
Ваша оценка

Кратко

Diataxis documentation framework practice guide.

Описание

Что делает этот навык

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.

Когда его использовать

  • 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

Пример сценария

ВВОД

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

АГЕНТ
  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

ВЫВОД

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

Установка

clawhub install amumulam/diataxis-writing

Выполните команду CLI или вставьте промпт в Claude Code, Cursor, Codex — любой кодинг-агент, которым пользуетесь.

Ссылки