跳到正文
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 或你在用的任意编程智能体里。

链接