Liberty 版本用户指南重组¶

备选方案¶

• 保持指南现状不变
• 合并云管理员指南和管理员用户指南
• 合并管理员用户指南和最终用户指南

负责人¶

主要负责人

Lana Brindley (loquacity)

其他贡献者

用户指南专业团队 任何具有信息架构经验的人员

工作项¶

• 开发用户/任务矩阵，并定义一组有限的角色来使用用户指南内容。
• 重写每个指南的摘要，以明确识别每个文档的读者对象和目的
• 删除仪表板章节中不必要/显而易见的操作步骤，例如“删除镜像”或“管理实例”等。
• 确定如何呈现任务的良好结构，包括使用仪表板或 CLI 以及编辑配置文件。
• 尽可能减少指南之间的重复。将云管理员指南指向管理员用户指南，将管理员用户指南指向最终用户指南，以便读者完成进一步的任务。这些信息可能适合放在摘要中。
• 更新管理员和项目选项卡的仪表板图像。
• 通过针对 Liberty puddle 进行测试，验证操作步骤是否适用。
• 操作步骤的一致性：有些使用表格，有些使用变量列表，例如
  • 创建网络（普通变量列表）
  • 启动实例（粗体变量列表）
  • 管理堆栈和访问与安全（表格）
  • 管理对象（项目符号）
• 操作步骤中的间距不一致，例如，请检查“将对象从一个容器复制到另一个容器的操作步骤”和“在用户指南的‘管理对象’部分中，创建不带文件的仅元数据对象的操作步骤”。
• 某些主题在 TOC 中重复出现，例如：在用户指南中，在 OpenStack 仪表板章节中登录仪表板，以及在 OpenStack 命令行客户端章节中从概述到管理卷。 [https://docs.openstack.org/user-guide] 类似地，一些章节在管理员用户指南中重复出现。 [https://docs.openstack.org/user-guide-admin]