双向性

Diátaxis ¶ 技术文档创作的系统方法。 Diataxis 是一种思考和制作文档的方式。它规定了内容、体系结构和形式的方法，这些方法是从理解文档用户需求的系统方法中产生的。 Diátaxis 确定了四种不同的需求，以及四种相应形式的文档 - 教程、操作指南、技术参考和解释。它将它们置于系统关系中，并建议文档本身应该围绕这些需求的结构进行组织。 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 成为我们信息架构的北极星。当我们不确定新内容应该放在哪里时，我们会查阅框架。对于读者和贡献者来说，我们的文档现在比以往任何时候都更加清晰。 — 亚当·施瓦茨