Diátaxis 是一种思考和创作文档的方式。

Diátaxis 解决与文档内容（写什么）、风格（如何写）和架构（如何组织）相关的问题。

avatar

教程 - 学习导向

  • 教程是一种课程，通过一系列的步骤引导读者完成某个项目。
  • 旨在帮助初学者掌握特定技能或概念。
  • 提供详细的指导，通常包括示例、演示和互动元素，以促进读者的实际学习体验。

操作指南 - 任务导向

  • 操作指南提供了解决现实世界问题所需步骤的指南。
  • 侧重于帮助用户达到特定目标，如完成某项任务或解决具体问题。
  • 提供明确的步骤和操作建议，以使用户能够迅速、准确地执行特定任务。

参考 - 信息导向

  • 参考指南描述产品和操作产品的技术细节。
  • 提供深入的技术描述、规范和详细的产品信息。
  • 可包括 API 文档、配置选项、参数说明等，以满足用户对产品内部工作原理的深入了解。

解释 - 理解导向

  • 解释是对特定主题进行深入讨论，澄清和照亮相关概念。
  • 目的是帮助读者更深入地理解产品、技术或相关主题。
  • 可包括概念解释、背景知识、原理说明等，以满足用户对更广泛知识领域的渴望。

注: 更多详细内容可参考 https://librehugohu.github.io/trans/di%C3%A1taxis/ 。