菜单
Audit existing documentation against the Diátaxis framework's four quadrants. Use when reviewing documentation that feels unclear, when assessing documentation quality, or when preparing for a documentation reorganization.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
Convert mixed documentation into separate Diátaxis quadrant documents. Use when documentation exists but mixes tutorials, how-tos, reference, and explanation content together, or after a diataxis-audit identifies mixed content.
Create new documentation following the Diátaxis framework. Use when writing documentation from scratch, when a user requests a tutorial, how-to guide, reference, or explanation document, or when filling documentation gaps.
Plan documentation architecture for a project using the Diátaxis framework. Use when organizing documentation for a new project, restructuring existing documentation, or designing a documentation strategy.
基于 SOC 职业分类
| name | diataxis-audit |
| description | Audit existing documentation against the Diátaxis framework's four quadrants. Use when reviewing documentation that feels unclear, when assessing documentation quality, or when preparing for a documentation reorganization. |
| metadata | {"author":"Georges Martin <jrjsmrtn@gmail.com>","version":"0.1.4"} |
| license | MIT |
Audit existing documentation against the Diátaxis framework to identify mixed quadrants, gaps, and quality issues.
Practical Theoretical
+----------------+------------------+
Study | TUTORIALS | EXPLANATION |
| (learning) | (understanding) |
+----------------+------------------+
Work | HOW-TO | REFERENCE |
| (problem) | (information) |
+----------------+------------------+
Key principle: These quadrants must remain distinct. Blurring boundaries is the most common documentation problem.
Read all documentation files in the target path. For each file, record:
For each document or section, classify using these questions:
| Question | If Yes → |
|---|---|
| Is it a guided learning experience building to a result? | Tutorial |
| Does it solve a specific, practical problem? | How-to guide |
| Does it describe the system factually and completely? | Reference |
| Does it explain why things work the way they do? | Explanation |
If a section answers multiple questions, it is mixed — flag it.
Check each document against its quadrant's anti-patterns:
Tutorials that:
How-to guides that:
Reference that:
Explanation that:
Check which quadrants are missing entirely:
For documents that are correctly classified, assess quality:
Tutorial quality:
How-to quality:
Reference quality:
Explanation quality:
Generate an audit report containing:
# Diátaxis Audit Report
## Summary
| Document | Intended Quadrant | Actual Quadrant(s) | Quality | Issues |
|----------|-------------------|---------------------|---------|--------|
| ... | ... | ... | ... | ... |
## Mixed Content (requires splitting)
### [filename]
- Lines N-M: Tutorial content mixed into reference → extract to tutorials/
- Lines X-Y: Explanation mixed into how-to → extract to explanation/
## Missing Quadrants
- [ ] Tutorial: [impact of absence]
- [ ] How-to: [impact of absence]
- [ ] Reference: [impact of absence]
- [ ] Explanation: [impact of absence]
## Recommendations (priority order)
1. [Highest impact action]
2. ...
diataxis-convert: Split mixed documents identified by this auditdiataxis-create: Fill gaps identified by this auditdiataxis-plan: Design the target documentation architecture