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

问题描述¶

OpenStack UX 项目希望在 OpenStack 文档贡献者指南中添加一个章节，为 OpenStack 项目团队开发的任何图形用户界面 (GUI) 提供关于保持一致的结构、风格和语法的指导。该指南可应用于面板标题、模态框标题、模态框章节标题、章节描述、标签等 IA 工作。

这项工作的价值在于帮助为操作员、管理员和最终用户提供改进的可用性。

提议的变更¶

添加一个章节来解决 UI 内容指南问题。该 UI 内容指南章节可以作为 OpenStack 文档贡献者指南中写作风格章节的同级章节添加。建议的目录

• 价值/简介
• UI 中文本的大小写指南
  • 句子大小写风格的示例
  • 标题大小写风格的示例
  • 使用句子大小写风格的常见 UI 元素/标题
  • 使用标题大小写风格的常见 UI 元素/标题
  • UA 备忘单（以图像直观地显示风格）
• 常见操作标签（例如，取消、添加、关闭、删除等），其他常见标签（例如，IP 地址）
• 一致地引用用户界面元素（链接到 ui-terminology.html）
• 遵循写作风格指南（链接到贡献者指南中的页面）
• 错误消息指南（结构、清晰度、完整性）
  • 结构定义
  • 示例

实现¶

依赖项¶

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

测试¶

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

参考资料¶

• 讨论可以通过任何官方媒介进行，包括 #openstack-doc 中的 IRC 以及主题中带有 [ui-content-guidelines] 的 openstack-docs 邮件列表。