在贡献者指南中添加 UI 内容指南

向贡献者指南添加 UI 内容指南

https://blueprints.launchpad.net/openstack-manuals/+spec/ux-personas

在 OpenStack 文档贡献者指南的 UI 指南部分添加 OpenStack 用户画像。

问题描述

OpenStack UX 项目希望在 OpenStack 文档贡献者指南中添加一个章节,描述由 OpenStack UX 项目团队开发的画像。

用户可以将画像应用于开发设计决策,将画像用作新指南和变更指南评估需求的 IA 资源,并在可能的营销材料中使用。

这项工作的价值在于帮助为开发人员、设计师和审查者提供对 OpenStack 用户的更好认识。有了这种认识,他们就可以在牢记适当受众目标和由此产生的任务流程的情况下设计和开发 OpenStack。画像有助于建立跨项目的统一性,提高对客户及其目标的认识,并沟通不同客户之间的差异。

提议的变更

在贡献者指南的新 UX/UI 部分,添加一个关于画像的主题集合。画像部分可以作为 OpenStack 文档贡献者指南中已有的 UI 文本指南和(提议的)UI 启发式检查清单部分的并列章节添加。

建议的目录

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

  • 价值/简介
  • UI 文本指南(已存在)
  • UI 启发式检查清单(新的,在单独的规范中提出)
  • UX 用户画像(新的,由本规范提出)

在画像部分,将详细阐述以下画像。

云用户画像

画像信息将基于模型公司及其生态系统。它们描述了云采用阶段,并描述了每个公司中定义的多个角色。在每个公司中,执行类似任务的角色可能被称作不同的名称。同一个人执行多个角色或共享任务也很常见。初步研究表明,角色生态系统复杂多样。

请联系 Piet Kruithof(参见下文 Assignee(s))获取最新版本的画像。

备选方案

  1. 不要添加 UX 用户画像。

  2. 添加画像,但将它们创建在新的 UX 设计工具指南中。一封电子邮件已分发给文档项目,讨论了在 docs.openstack.org 的贡献者指南部分下创建一个新的 UX 设计指南,以容纳 UX 相关资源和工具,面向跨项目受众。以下是电子邮件中讨论的选项(发送日期:2016 年 3 月 7 日)。有关更多详细信息和历史记录,请参阅文档邮件列表或 OpenStack 电子邮件存档。

    选项 A

    在 docs.openstack.org 的贡献者指南部分下创建 OpenStack UX 设计指南:开发者工具指南。该指南将容纳 UX 设计材料,例如引人入胜的 UX、用户画像、用例以及包含启发式检查清单等资源部分。基本上,创建一个设计角概念。指南名称待定。

    • 优点:与其他贡献者指南并列。在 OpenStack 中更突出地关注 UX/UI 设计。我们可以从适当的位置引用该指南以提高可见性。
    • 缺点:新的指南后勤工作更复杂 - 需要后勤支持。此选项需要更长的时间才能开始审查。
    选项 B

    添加到现有的文档贡献者指南,但修改指南的范围。

    • 优点:现有指南后勤工作更容易,并且内容可以更快地进行审查。UI 指南和内容将位于同一位置。我们最近添加到文档贡献者指南中的 UI 文本指南链接到新的 UI 启发式检查清单。
    • 缺点:不再仅用于文本指南,因此当前指南的范围将略微扩展,以包含专门针对跨项目受众的 UX/UI 工具的部分。
    选项 C

    按原样添加到现有的文档贡献者指南,以后可能进行调整。

    • 优点:内容可以快速进行审查,对后勤的影响最小。
    • 缺点:范围可能会让用户感到困惑,以后进行调整会延迟一些工作。

实现

工作项

  • 就新章节的位置和内容结构达成共识。
  • 确定要创建的新主题,并使用 [blueprint ux-personas] 标签提交内容/审查。

依赖项

这项工作是 UX 和文档团队之间的合作,需要两个项目的投入。

测试

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

参考资料

  • 讨论可以通过任何官方渠道进行,包括 #openstack-doc 中的 IRC,以及主题中包含 [ux-personas] 的 openstack-docs 邮件列表。
Creative Commons Attribution 3.0 License

除非另有说明,本文档根据 知识共享署名 3.0 许可协议 授权。请参阅所有 OpenStack 法律文件

docs-specs