在贡献者指南中添加 UI 启发式检查清单

更新日期：2018-12-06 13:55

向贡献者指南添加 UI 启发式检查清单¶

https://blueprints.launchpad.net/openstack-manuals/+spec/ui-heuristic-checklist

在 OpenStack 文档贡献者指南的 UI 指南部分添加一个 OpenStack UI 启发式检查清单。

问题描述¶

OpenStack UX 项目希望在 OpenStack 文档贡献者指南中添加一个章节，其中包含由 OpenStack 项目团队（UX 和 ID）开发的图形用户界面 (GUI) 启发式检查清单，并参考了 Horizon 和 OpenStack CLI 的意见。该内容与我们为 Mitaka 发布的 UI 文本指南相关联。

启发式评估是一种简单的检查方法，允许工程师和设计师审查设计中常见的可用性问题。其优点在于启发式评估成本低，相对容易使用，适合评估设计的个人。启发式评估的另一个优点是它们有助于保持多个设计审查的一致性和透明度。

一个启发式的例子是 Jakob Nielsen 在 1990 年代开发的“用户界面设计的 10 条可用性启发式”，其中包含错误恢复和系统状态的原则。OpenStack 社区的启发式包含针对云开发的具体原则，并侧重于设计可扩展性，以及诸如典型生产部署中的图像数量之类的示例。

这些指南的草稿正在进行中，可以在这里查看：https://etherpad.openstack.org/p/mitaka-openstackux-heuristic

这项工作的价值在于通过创建有助于促进 OpenStack GUI 界面一致性的工具，从而帮助提高操作员、管理员和最终用户的可用性。

提议的变更¶

在贡献者指南的新 UX/UI 部分添加一个关于 UI 启发式检查清单的主题。启发式检查清单可以作为 UI 文本指南（已存在）和 OpenStack 文档贡献者指南中（提议的）UX 人物部分的一个同级添加。

建议的目录

UX/UI 指南（章节标题已更新以反映更广泛的范围）

价值/简介
UI 文本指南（已存在）
UI 启发式检查清单（新，由本规范提出）
UX 人物（新，在单独的规范中提出）

备选方案¶

不添加 UI 启发式检查清单。
添加检查清单，但将其创建在新的 UX 设计指南中。一封电子邮件已分发给文档项目，讨论了创建一个新的 UX 设计指南，以容纳面向跨项目受众的 UX 相关资源和工具的想法。这些选项是在 3 月 7 日发送的电子邮件中讨论的。有关更多详细信息和历史记录，请参阅电子邮件。
选项 A
在 docs.openstack.org 的贡献者指南部分下，创建一个 OpenStack UX 设计指南：开发者工具指南。该指南将容纳 UX 设计材料，例如引人入胜的 UX、人物、用例、资源部分以及启发式检查清单等。基本上，创建一个设计角概念，指南名称待定。
- 优点：与其它贡献者指南平级 - 更加突出 OpenStack 中的 UX/UI 设计，我们可以从适当的位置引用指南以提高可见性
- 缺点：新的指南 - 后勤工作更复杂，需要后勤支持。获得评审需要更长时间
选项 B：添加到现有的文档贡献者指南，但修改
指南的范围。
- 优点：现有指南 - 后勤工作更简单，内容可以更快地进行评审。UI 指南内容位于一个位置（新的 UI 启发式检查清单链接到我们最近添加到文档贡献者指南中的 UI 文本指南。）
- 缺点：不再仅用于文本指南，因此指南的当前范围将略微扩展，以包含专门针对跨项目受众的 UX/UI 工具的部分。
选项 C：按原样添加到现有的文档贡献者指南，
以后可能进行调整…
- 优点：内容可以快速进行评审，对后勤的影响最小
- 缺点：范围可能会让用户感到困惑，稍后调整会延迟一些工作

实现¶

负责人¶

主要负责人

其他贡献者

工作项¶

就新章节的位置和内容结构达成共识。
确定要创建的新主题，并使用 [blueprint ui-hueristic-checklist] 标签提交内容/评审。

依赖项¶

这项工作是 UX 和文档团队之间的协作，需要 UX 项目团队的输入和启发式检查清单的创建。

测试¶

测试将遵循标准文档审查流程。

参考资料¶

可以使用任何官方媒介进行讨论，包括 #openstack-doc 中的 IRC 以及主题中包含 [ui-heuristic-checklist] 的 openstack-docs 邮件列表。