Documentation/UserAnalysis
目录
OpenStack 文档用户分析
到目前为止，OpenStack 文档是根据快速变化的项目优先级有机增长的。作为文档团队，我们希望重新聚焦现有的文档，使其能够以经过深思熟虑且可扩展的方式增长。为此，我们需要首先了解我们的用户是谁，以及他们希望通过阅读文档实现什么结果。
本文档的目的
本文档旨在帮助 OpenStack 文档团队更好地支持其受众：部署、维护和使用 OpenStack 的用户。
可用性目标
OpenStack 文档应尽最大努力遵循以下准则
- 搜索和导航
- 用户应该能够使用搜索找到主题，或者通过浏览找到主题。如果需要多个主题，用户应该能够轻松地导航到下一个主题。每个指南都应该有一个摘要，说明指南的目的和目标受众。
- 定位
- 用户应该始终知道他们在文档中的位置相对于整体的位置，以及相对于他们之前的位置。提供主题来帮助用户定位思维过程和复杂任务。
- 决策制定
- 用户应该能够选择合适的主题，决定向软件提供哪些输入，并解释他们的结果。
- 任务完成
- 用户应该遵循文档中主题的有效路径来完成他们的目标。
- 任务泛化
- 用户应该能够将文档中的信息推广到未明确记录的情况。例如，他们应该能够确定各种应用程序的适当输入是什么。
- 诊断和从错误中恢复
- 用户应该能够学习如何诊断问题、纠正问题，并可能在未来防止问题发生。
- 突出危险
- 清楚地突出用户可能遇到的危险，并解释潜在破坏性操作的后果。
- 文档与现实世界术语和概念的匹配
- 文档应该使用对用户熟悉并且可能取决于其角色（例如，管理员与最终用户）的语言和概念。融入用户通常会搜索的关键词至关重要，并考虑 SEO 元数据。
- 极简主义写作
- 主题应避免无关信息。主题中的每个额外信息单元都会与相关信息竞争，从而降低相关信息的查找能力。
- 布局
- 应仔细考虑内容的呈现方式。考虑信息是最好以段落、列表还是图形的形式呈现。智能地分块内容。
- 一致性和标准
- 用户不应该想知道不同的词语、情况或操作是否意味着相同的事物。这会增加认知负荷，并妨碍他们快速完成任务。遵循平台、软件和领域约定。遵守 OpenStack 文档约定：https://docs.openstack.org/contributor-guide/index.html
- 与软件集成
- 用户不应该为了访问文档而退出他们的软件工作流程。在产品中提供对文档的搜索访问，并在可能的情况下提供上下文相关的帮助。
用户分析
本次受众分析是对现有 OpenStack 文档套件用户的深入研究。通过本次分析，我们将开发一组角色，这些角色将指导未来的文档开发。本次分析还将影响指南的交付机制和位置、信息的格式和设计，以及读者用于查找信息和发现新主题的信息路径。
目标受众画像
- 软件开发人员
- 协助软件设计规范，提出改进建议，编写代码并在上线前测试产品。
- 操作员
- 负责安装和配置硬件、软件和相关基础设施。
- 系统管理员
- 在安装的 OpenStack 环境中部署和管理租户/项目。需要很好地理解 OpenStack 架构、软件安装和配置，并知道如何进行基本的故障排除。
- 最终用户
- 在部署的租户/项目中创建和管理虚拟机。
- 管理层 (CTO/CFO)
- 需要了解 OpenStack 解决的问题。需要了解当前版本的 OpenStack 与先前版本相比的优势。
目标受众环境
下表显示了受众及其物理和运营环境。环境不提出任何影响文档设计的特殊要求。
| 角色 | 办公室 | 实验室 | 数据中心 |
| 软件开发人员 | x | ||
| 操作员 | x | x | x |
| 系统管理员 | x | x | |
| 最终用户 | x | ||
| 管理层 (CTO/CFO) | x |
需求分析
- 需要针对入门提供逐步教程，并提供更全面的信息，超越简单的概念验证
- 需要概念、屏幕截图和图表来了解所有内容如何协同工作
- 需要了解所有活动部件，以便诊断和解决各自责任范围内的所有问题
高级任务列表
这些任务已被确定为 OpenStack 安装和使用期间的关键决策点。这些任务中的每一个都包含许多较小的子任务，并且可以由一个或多个个人受众执行
- 了解 OpenStack 解决的问题
- 选择服务
- 规划安装
- 执行安装
- 设置网络
- 创建项目
- 创建实例
- 维护项目
- 维护实例
- 排除故障
- 持续维护任务
用户/任务矩阵
以下用户/任务矩阵显示了任务与用户之间的关系。用户执行任务的可能性在 1（低）到 10（高）的范围内进行评估。
| 任务 | 软件开发人员 | 操作员 | 系统管理员 | 最终用户 | 管理层 |
| 了解 OpenStack 解决的问题 | 10 | 8 | 8 | 8 | 8 |
| 选择服务 | 10 | 10 | 1 | 1 | 1 |
| 规划安装 | 5 | 10 | 7 | 1 | 1 |
| 执行安装 | 5 | 10 | 7 | 1 | 1 |
| 设置网络 | 5 | 10 | 10 | 1 | 1 |
| 创建项目 | 5 | 10 | 10 | 1 | 1 |
| 创建实例 | 5 | 10 | 10 | 10 | 1 |
| 维护项目 | 5 | 5 | 10 | 1 | 1 |
| 维护实例 | 5 | 5 | 10 | 10 | 1 |
| 排除故障 | 8 | 8 | 8 | 7 | 1 |
| 持续维护任务 | 1 | 10 | 10 | 1 | 1 |
