mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-22 04:45:19 +00:00
vickyhella
100 lines
7.0 KiB
Markdown
100 lines
7.0 KiB
Markdown
---
|
|
title: Divio 文档介绍
|
|
---
|
|
|
|
[Divio 文档系统](https://documentation.divio.com/)是一种软件文档范式，它以功能为基础，旨在为用户提供具体、简明而且目的明确的文档。一般来说，Divio 由四个类别组成，分别是教程、操作指南、参考指南和解释。
|
|
|
|
我们将文档划分为[开始使用](../../getting-started.md)、[操作指南](../../how-to-guides.md)（包括[新用户指南](../../pages-for-subheaders/new-user-guides.md)和[高级用户指南](../../pages-for-subheaders/advanced-user-guides.md)）、[参考指南](../../reference-guides.md)、[说明](../../explanations.md)、[常见问题](../../faq.md)、[故障排除](../../troubleshooting.md)，以及[参与 Rancher 社区贡献](../../contribute-to-rancher.md)几个部分。
|
|
|
|
|
|
## 开始使用
|
|
|
|
**开始使用**章节能帮助你快速启动和运行 Rancher。
|
|
|
|
本章节旨在帮助用户部署 Rancher 和工作负载，并快速有效地安装或升级 Rancher。
|
|
|
|
请参阅[简介](../../pages-for-subheaders/introduction.md)、[快速入门指南](../../pages-for-subheaders/quick-start-guides.md)以及[安装和升级](../../pages-for-subheaders/installation-and-upgrade.md)部分了解更多信息。
|
|
|
|
## 操作指南
|
|
|
|
操作指南描述了用户完成某些任务的实际步骤。在 Rancher 中，我们将操作指南进一步细分为[新用户指南](#新用户指南)和[高级用户指南](#高级用户指南)。
|
|
|
|
### 新用户指南
|
|
|
|
新用户指南（也称为教程）描述了某些操作的实际步骤。这些文档是“学习导向”的，也就是说用户通过“操作”来学习。
|
|
|
|
新用户指南旨在引导初学者或 Rancher 的日常用户通过一系列步骤来学习如何进行某些操作。这些文档旨在帮助用户通过使用易于遵循、有意义且可重复的操作来了解如何完成任务。这些指南将帮助用户完成工作，并能立刻看到效果。
|
|
|
|
正常来说，普通 Rancher 用户的技术水平高于“初学者”，但是，我们的新用户指南为初学者以及经验丰富的 Rancher 用户提供相同的指导。我们结合使用了高级语言和技术语言来介绍各个主题，并指导用户完成 Rancher 用户需要了解的通用任务。
|
|
|
|
你可以在[此处](../../how-to-guides/new-user-guides/kubernetes-resources-setup/workloads-and-pods/deploy-workloads.md)找到新用户指南的一个示例。
|
|
|
|
### 高级用户指南
|
|
|
|
高级用户指南是“问题导向”的文档，用户可以从中学习如何解决问题。高级用于指南与新用户指南的主要区别在于，高级用户指南面向更有经验或更高级的用户，这些用户对文档有更多的技术需求，而且已经了解 Rancher 及其功能。他们知道自己需要做什么，只是需要额外的指导来完成更复杂的任务。
|
|
|
|
应该注意的是，新用户指南和高级用户指南都没有提供详细的解释或讨论（这些文档不包括在本部分）。操作指南侧重于引导用户通过可重复、有效的步骤来学习新技能、掌握某些操作或解决某些问题。
|
|
|
|
你可以在[此处](../../how-to-guides/advanced-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/dynamically-provision-new-storage.md)找到高级用户指南的一个示例。
|
|
|
|
## 参考指南
|
|
|
|
参考指南是用户可以学习的产品或流程描述。参考指南是“信息导向”的，主要用于描述。
|
|
|
|
本章节的文档可能包含一些操作步骤，但是描述操作步骤不是本章节的主要目的。
|
|
|
|
使用参考指南的用户熟悉且了解如何使用 Rancher。当用户需要参考具体使用细节时，用户可以获取更详细的使用描述。
|
|
|
|
Rancher 参考指南示例：
|
|
1. [Rancher Manager 架构](../../pages-for-subheaders/rancher-manager-architecture.md)
|
|
2. [集群配置指南](../../pages-for-subheaders/cluster-configuration.md)
|
|
|
|
## 说明
|
|
|
|
说明文档主要用于为某个任务或主题背后的“原因”提供理论知识。说明文档是“理解导向”的，用于拓宽用户的知识。在本节中，用户可以找到有关主题的上下文和背景、替代方案和意见等，还可能找到历史原因、相关限制以及流程的工作原理。
|
|
|
|
说明文档不会像操作指南那样指导用户进行操作，也不会像参考文档那样给出详细的描述。说明文档用于提供简单和复杂主题的实质和背景。
|
|
|
|
由于我们以前的大多数文档都不是"以讨论为导向"的，因此我们的新文档会增加这一部分内容。目前，我们以[Rancher 中的集成](../../pages-for-subheaders/integrations-in-rancher.md)来讨论我们的集成产品。
|
|
|
|
### Rancher 中的集成
|
|
|
|
Rancher 已经积累了多个产品和项目，而且已将它们集成到 Rancher UI 中。为了帮助用户了解这些集成，我们已将此小节添加到**说明**下。
|
|
|
|
集成示例：[Harvester](../../explanations/integrations-in-rancher/harvester.md) 和 [NeuVector](../../explanations/integrations-in-rancher/neuvector.md)
|
|
|
|
## 其他文档类别
|
|
|
|
### 常见问题
|
|
|
|
[常见问题](../../faq.md)包含了用户常见的 Rancher v2.x 问题。这些问题可能是技术性的或非技术性的。
|
|
|
|
我们会不断补充和优化这一部分，你可以常来浏览更新的内容。
|
|
|
|
### 故障排除
|
|
|
|
[故障排除](../../troubleshooting.md)旨在帮助新老 Rancher 用户解决他们在使用 Rancher 时可能遇到的已知问题。
|
|
|
|
我们会不断补充和优化这一部分，你可以常来浏览更新的内容。
|
|
|
|
### 参与 Rancher 社区贡献
|
|
|
|
为了提高文档的质量，我们一直在更新、检查和改进 Rancher Manager 文档。同时，我们也呼吁社区用户参与贡献。
|
|
|
|
你可以查阅[参与 Rancher 社区贡献](../../contribute-to-rancher.md)章节，了解 Rancher 使用的仓库，以及学习如何构建仓库、提交 issue 或创建 PR。
|
|
|
|
我们会经常 review 用户的贡献，并将及时向贡献者提供反馈。
|
|
|
|
## 重叠类别
|
|
|
|
你可能会发现，各个文档类别（新用户指南、高级用户指南、参考资料）存在一些重叠。这是因为信息流是流动的，因此通常情况下，某些文档在逻辑上可能属于多个类别。虽然我们的文档有一些重叠，但如果我们记住每个类别的主要功能并努力区分它们，那么文档将更加清晰可用。
|
|
|
|
## 新结构目标
|
|
|
|
旧版 Rancher 文档侧重于单个功能和主题，而新的 Divio 范式则优先考虑功能和及其内在联系。
|
|
|
|
我们旧版的文档结构没有采用 Divio 范式（例如，并非每个文档都可以合理地放入用户指南或参考文献中）。某些文档可能包含多个文档功能的内容。
|
|
|
|
因此，我们一直在努力把现有的文档转移到基于文档功能的新结构。未来，我们将根据需要创建、重写和重塑我们的文档，使我们的文档更加符合 Divio 结构、目的及其设计概念。
|
|
|
|
最终，我们的文档将强调单个主题或功能，从而更加有效地帮助我们的用户。 |