本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Open Collective
- 技术文档工程师：
- Anna e só
- 项目名称：
- 完善常规帮助文档
- 项目时长：
- 标准时长（3 个月）
Project description
第一印象 常见情况是有些文档页面包含说明但没有支持媒体（视频、GIF、图片），而同一章节下的其他章节却包含更完整的条目。例如，Edit Collective 仅包含说明，而添加财务主机包含支持媒体。
在我浏览的网页中，未使用替代文本属性来描述任何媒体。由于缺少图片说明，使用屏幕阅读器的用户以及网速较慢（任何媒体都无法加载）的用户无法全面了解文档。
该文档的某些部分合并了有关界面导航的常见问题解答和直接说明，例如更改财务主机。由于文档界面中没有目录，如果用户知道注册记录发生变化的后果，但只想获得客观的说明，则可能会认为文档过于冗长且太过切合。
尽管技术文档的语言非常一致，但公开提供的样式指南中关于如何编写文档的内容太少。由于贡献页面会提及对技术文档的贡献，因此 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 文档季申请之前规划的行程。
交付成果 - 关于所开展活动的十份公开报告 - Open Collective 和外部贡献者均可使用的公开风格指南 - 用户文档页面经过改进