SuperAPI AI 工具集

diataxis

编程与开发

查看项目

更新于 10-16 03:46

技能介绍

用途:Diátaxis 是一套编写与修复技术文档的 runbook,适用于 README、API 文档、指南、教程、参考、入门及开发者文档等。

主要能力:把文档拆成四种模式——教程(面向初学者学习,边做边教)、操作指南(面向工作中的用户完成具体任务)、参考(面向工作中的用户查询事实信息)、解释(面向学习中的用户理解原因)。核心主张是:多数文档问题源于同一内容想同时服务多种需求,拆开四种模式即可消解混乱。另有“指南针”决策法:先判断内容是指导行动还是认知,再判断是服务学习还是应用,从而归类。

使用方式:按症状匹配——不清楚写哪种文档先分类;页面臃肿、混杂教学加步骤加规格用 wrong-type-tree;用户无法起步、无法完成任务、找不到事实或不理解原因用 gaps-tree;文档整体杂乱用 restructure-tree。大型文档集可先运行 bash references/queries/scan-docs.sh <docs_root> 进行分诊。归类后阅读对应类型指南,按 workflow.md 小步推进:选一小块、评估、决定一个下一步动作、执行并发布,不做自上而下的大重写。用 quality.md 评估功能质量与深层质量,用 assets/templates/report.md 记录审计。可选 config.json 指定文档位置与审计日志,缺失时回退为询问,不阻塞使用。

适用场景:新写文档、诊断臃肿页面、补足薄弱模式、重构或审计现有文档集、判断某段内容属于哪种模式。

限制:不适用于在已正确模式内做纯文案润色(应用 copywriting 技能),也不适用于设计、规格或提案类文档(多为解释,宜用 dev-rfc 或 feature-spec)。Diátaxis 是描述性的,不是填空模板。首要重构前建议先读 gotchas.md 了解常见陷阱。配置与具体文件细节资料未完整提供。