本页详细介绍了 Google 文档季收录的技术文案项目。
项目摘要
- 开源组织：
- 打开“Open Collective”
- 技术文档工程师：
- Anna e só
- 项目名称：
- 改进常规帮助文档
- 项目时长：
- 标准时长（3 个月）
Project description
第一印象 有时文档页面包含的说明没有支持媒体（视频、GIF、图片），而同一章节下的其他部分包含更完整的条目，例如，Edit Collective 仅包含说明，而 Add Fiscal Host 纳入了辅助媒体。
在我浏览的网页中，没有任何媒体使用 alt 文本属性进行描述。由于缺少图片说明，因此对于使用屏幕阅读器的用户和互联网连接速度较慢（任何媒体都可能无法加载）的用户而言，文档内容缺乏全面了解。
文档的某些部分合并了常见问题解答和有关浏览界面的直接说明，如更改财务主机。由于文档界面中没有目录，如果用户知道更改注册记录的后果，只想获得客观说明，可能会认为该文档冗长且过于琐碎。
虽然技术文档的语言非常一致，但公开的风格指南对文档的编写方式的说明过于简略。由于贡献页面提到了对技术文档的贡献，因此 Open Collective 和潜在贡献者都将受益于更全面的指南。
方案 我建议检查用户帮助页面，重新考虑其呈现方式和当前结构。
方法和时间安排 我希望与社区合作，通过促进不同时长的持续反馈周期来改进 Open Collective 文档。
社区凝聚期（2019 年 8 月 1 日至 9 月 1 日）：了解 Open Collective 社区！对热门和新兴项目的活跃成员进行访谈，询问他们关于文档当前状态的问题（报告 1）。在 Open Collective 文档中记录用于跟踪查询和问题的所有内部系统，以及记录这些系统的流程（报告 2）。评估当前版本文档中的潜在问题，并准备解决这些问题的方案（报告 3）。
9 月 2 日至 6 日：首次反馈和调整周期，会考虑社区在社区互动期内提出的所有意见和建议。我们的方案可以实施了吗？有什么需要改变的吗？（报告 4）
9 月 9 日至 20 日：开发了概念验证，增加了文档中人口较少的章节。公开版风格指南的草稿（报告 5）。
9 月 23 日至 25 日：提交概念验证以供评估（封闭式群组）。
9 月 26 日至 27 日：我们的概念验证在上线之前是否需要进行任何调整？我们需要更多时间吗？请进行相应调整。（报告 6）
9 月 30 日至 10 月 9 日：概念验证版正式发布。第二轮反馈（公开群组）。
10 月 10 日至 15 日：最终概念验证评估和调整周期。（报告 7）
10 月 16 日至 20 日：暂时休息一下 [1]。
10 月 21 日至 11 月 23 日：公共风格指南最终确定（报告 8）。将样式指南中的所有说明应用于所有用户文档页面（报告 9）。评估执行的所有活动以及为社区提供的进一步建议（报告 10）。
项目持续时间可应要求延长。
[1]：在我的 Google 文档应用季前就规划好行程。
交付成果 - 关于所执行活动的 10 份公开报告 - 一个可供 Open Collective 和外部贡献者使用的公开样式指南 - 经过改进的用户文档页面