用途:为创建、重组、审阅或改进技术文档提供方法,核心理念是让每份文档只服务一种用户需求,并依据用户当前行为(而非主题、格式或难度)来分类。
主要能力:提供“需求罗盘”,按两个问题划分类别——用户需要行动还是认知;是在学习中获取技能还是在工作中应用技能。由此对应四种文档类型:教程(行动+学习,通过引导体验学习)、操作指南(行动+应用,完成真实任务)、参考(认知+应用,工作中查阅权威事实)、解释(认知+学习,通过反思建立理解)。该罗盘可用于文档、章节、段落乃至句子层级,若内容服务多格应拆分并交叉链接。
使用方式:先命名用户与场景,选定一种主文档类型;其次以代码、模式、接口、命令、运行时行为、规范等权威来源夯实事实并解决矛盾;再界定边界并列出应链接到其他文档的相邻内容;然后按对应类型的契约撰写(教程侧重可控的分步学习体验并展示可见结果,操作指南标题写“如何达成某结果”并只含必要步骤,参考中立精确地描述语法、参数、类型、默认值、限制与错误,解释围绕真实的“为什么”展开并保持有界);最后建立教程、操作指南、参考与解释之间的交叉链接,并做验证。
适用场景:撰写新文档、文档审计、内容拆分与重组。审计时按文档类型归类发现的问题,引用冲突段落,指出受阻的用户需求,并给出最小改动建议。
限制:强调功能性质量(准确、完整、一致、有用精确)优先,随后才判断契合度与流畅度;Diátaxis 方法不能替代技术验证与编辑判断。方法改编自 Daniele Procida 的 Diátaxis,遵循 CC BY-SA 4.0。