返回顶部 切换目录侧边栏 一种系统化的技术文档编写方法。Diátaxis 是一种思考和执行文档的方式。它规定了从系统化理解文档用户需求而产生的内容、架构和形式的方法。Diátaxis 确定了四种不同的需求，以及四种对应的文档形式 - 教程、操作指南、技术参考和解释。它将这些放在一个系统关系中，并建议文档本身应该围绕这些需求的结构进行组织。Diátaxis 解决了与文档内容（写什么）、风格（如何写）和架构（如何组织）相关的问题。除了为文档的用户服务，Diátaxis 对文档的创建者和维护者也很有价值。它轻量级，易于理解且便于应用。它并不强加实施约束。它为文档带来了一个积极的质量原则，帮助维护者有效地思考自己的工作。 目录 ¶ 开始使用 Diátaxis 的最佳方式是在阅读简要入门后应用它。这些页面将帮助对这一方法进行直接、具体的理解。本节深入探讨了 Diátaxis 的理论和原则，并提出了支撑其理论基础的需求理解。Diátaxis 在实践中得到了验证。其原则在数百个文档项目中成功采用。Diátaxis 使我们能够构建一套高质量的内部文档，用户喜爱我们的文档，贡献者也乐于添加内容。 —Greg Frileux，Vonage 在 Gatsby，我们最近重新组织了我们的开源文档，Diátaxis 框架是我们在整个项目中的首要资源。这四个象限帮助我们优先考虑每种文档类型的用户目标。通过围绕 Diátaxis 框架重构我们的文档，我们使用户在需要时更容易发现他们需要的资源。 —Megan Sullivan 在重新设计 Cloudflare 开发者文档时，Diátaxis 成为我们信息架构的北极星。当我们不确定新内容该适合哪里时，我们会查阅这个框架。我们的文档现在比以往任何时候都更加清晰，无论是对读者还是贡献者。 —Adam Schwartz