Quarkus documentation content types
Quarkus 文档被构建成四种独特的内容类型：概念、方法、教程和参考。Quarkus 文档的组成和结构遵循 Diátaxis 系统文档框架，用于技术文档编写。每种内容类型都会解决不同的用户需求、实现不同的目的，并且需要采取不同的方法来创建。
Diátaxis documentation framework
我们选择将 Quarkus 文档与 Diátaxis 文档框架“6”对齐“5”，它定义了一种核心内容结构，该结构满足用户在查阅文档时会遇到的不同需求。
Image credit: [role="bare"]https://diataxis.fr/
以下是不同文档类型的一个简短摘要，但是如果你想更深入地了解此分类背后的原因，那么值得花时间阅读我们的网站。
Concept guides (Explanation)
说明是 discussion，对特定主题进行澄清和讲解。说明是 understanding-oriented。
优秀的概念指南：
-
专注于解释一个主题。它们的目的是帮助读者理解这个概念。
-
不会教授、指导或包含参考信息。如果你需要参考教程、操作方法或参考指南，请向读者指出可以在哪里找到这些内容，而不要直接在概念指南中复制这些信息。
-
提供背景信息和上下文，以说明 why 工作方式或构建方式。你可以引用设计决策、历史原因和技术限制来重申你的观点。
-
包含特定示例来说明讲解内容，但避免让讲解内容本身过度依赖特定的技术或实现模式。
-
从多个角度分析这个概念，并与其他概念进行比较，讨论这是否与读者的理解相关且有用。
-
可能会表达对所讲解的概念在不同的潜在用例或应用程序中存在的优点和缺点的意见。
How-to guides
操作方法指南是 directions，指导读者完成解决实际问题所需的步骤。操作方法指南是 goal-oriented。
优秀的如何操作指南：
-
指导（演练）或演示如何完成一项任务。
-
假设你拥有足够的上下文信息来开始这项任务。
-
描述完成一项任务所需的具体步骤，但这些步骤可能会出现在一项更大任务的中间。
-
不要解释概念，他们依托于其他文档（如概念）来解释。
-
可适应真实世界的用例。
-
实用（而不是完整）。