diataxis-writing
由 amumulam 提供
Coding Agents & IDEs简介
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
Ask user for language preference and preferred output method
- 2
Use the Diataxis compass to classify: is the content action guidance or cognitive knowledge, and is the reader acquiring or applying skills?
- 3
Determine type — how-to guide if the record is step-by-step resolution, explanation if it analyzes root cause
- 4
Select the troubleshooting template and write the document in the confirmed language
- 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 或你在用的任意编程智能体里。