文档中心概述
欢迎来到文档中心!本知识库采用业界广泛认可的 Diátaxis 架构 来组织和呈现内容。
Diátaxis 体系将所有技术文档系统地划分为四个不同的核心维度,以满足读者在不同阶段与场景下的阅读需求:
┌───────────────────────────┐
│ 学习导向 (Learning) │
实用 (Practical) ├─────────────┬─────────────┤ 理论 (Theoretical)
│ 教程 │ 说明解释 │
│ (Tutorials) │(Explanation)│
├─────────────┼─────────────┤
│ 操作指南 │ 参考 │
│(How-to) │ (Reference) │
└─────────────┴─────────────┘
│ 工作导向 (Working) │
└───────────────────────────┘
📚 四大分类导航
1. 🎓 教程 (Tutorials)
- 目标:以学习为导向(Learning-oriented),带你从零开始完成完整的基础流程。
- 适合人群:新手初学者,希望获得系统的入门引导和动手体验。
2. 🛠️ 操作指南 (How-to Guides)
- 目标:以解决实际问题为导向(Problem-oriented),提供具体任务的逐步操作配方。
- 适合人群:有一定基础的用户,遇到特定场景或问题需要查找现成解决方案。
3. 📖 参考 (Reference)
- 目标:以信息为导向(Information-oriented),提供严谨、准确、客观的技术规格、配置字典与 API 文档。
- 适合人群:日常开发与查阅者,需要快速查询参数定义、选项列表或接口详情。
4. 💡 说明解释 (Explanation)
- 目标:以理解概念为导向(Understanding-oriented),深入探讨架构设计、核心机制及设计决策背后的“为什么”。
- 适合人群:希望深入理解系统原理、背景与底层逻辑的读者。
:::tip 协作建议 在后续新增内容时,我们会根据内容的性质自动归入上述四大分类之一;若有无法涵盖的特殊场景,我们将共同商讨。 :::