当前阶段:
2020 季 Google 文档计划已于 2021 年 3 月 15 日结束。请参阅时间轴。
项目创意是开源组织针对项目提出的建议,技术撰写者可以在文档使用季期间与导师合作完成这些项目。
本页面上的信息适用于正在准备项目创意列表的开源组织管理员和导师。这些信息还有助于技术文档撰写者了解组织参与文档季。
示例项目
下面列举了一些技术文档工程师可以完成的项目类型:
在一个平台上构建文档网站,由技术文档撰写者和开源导师决定,并在网站上发布一组初始基本文档。平台示例:
重构开源项目的现有文档,以提供改进的用户体验或更无障碍的信息架构。
撰写产品或功能的概念性概览或简介。 通常,团队会从下往上创建技术文档,结果涉及大量细节,但很难从整体上了解产品。技术文档工程师可以解决此问题。
为备受关注的用例创建教程。
针对特定任务创建一套有针对性的方法指南。
创建贡献者指南,其中包括有关作为开源项目贡献者入门的基本信息,以及关于许可协议、拉取请求和审核流程、项目构建等的任何规则。
上述想法刻意在范围和规模上有所不同。任何项目所花费的时间取决于多种因素,包括文档集的大小、产品的复杂性、技术文档作者和开源导师的经验、开源项目提供的工具和流程等。
以上列表的目的是帮助您入门。您也可以建议其他类型的项目。
发布项目创意列表
您应该将项目创意发布在公开网页、博文或其他一些公开显示的文档中。
您的项目创意页面应包含以下内容:
有关您的开源组织的信息:
- 组织名称。
- 组织说明。
- 指向您的开源代码库和/或网站的链接。
- (可选)用于就文档季与贵组织联系的电子邮件地址。该地址应与您在组织的《文档季》申请表中添加的电子邮件地址相同。
- (可选)有关您的组织管理员和导师的信息,例如其显示名。它们应该与您在贵组织的文档 Season of Google 申请表单中提供的显示名称相同。
一则通知,说明贵组织正在申请参与今年的 Google 文档季。宣传和媒体页面包含徽标和其他内容,您可以在谈论文档剧季时使用。
您的项目创意,包括针对每个项目创意下文所述的信息。
当您为组织创建《文档季》应用时,应该添加指向您的项目创意页面的链接。
每个项目创意中的信息
每个项目创意必须至少包含以下信息:
- 项目名称:选择一个简洁但具有描述性的标题。
- 说明:对所需文档的详细解释。 详细描述您的初始想法。为所有感兴趣的技术文档编写人员提供扩展或完善想法的机会。
相关资料:
- 指向需要文档的开源项目的链接。
- 如果您提议的技术编写项目涉及对现有文档集的更新,请链接到该文档集。
- 如果您正在建议一个教程或一组方法指南,请描述需要记录的功能或用例。
- 如果您要提交贡献者指南,请链接到任何现有的 README 文件或其他相关资料(如果有)。如果没有可用的数据 那也没关系
- 如果相关,请添加指向其他项目中类似文档的链接。
项目构想的重要性
您的项目创意在很多方面都很重要:
- 通过采纳这些想法,您的组织可以制定必要的文档任务,并为与技术文档撰写者合作做好准备。
- 项目创意可让 Google 项目管理员了解在技术文档撰写人员与您的组织建立指导关系时将要从事的工作类型。Google 计划管理员会根据项目创意来评判组织参与文档季以及在整个计划期间指导技术文档撰写的承诺。
- 项目创意能够吸引对贵组织感兴趣的技术文档工程师。他们可以将您的建议项目用作基础来制定自己的项目提案。
相关信息
- 宣传和媒体页面包含徽标和其他内容,您可以在谈论文档剧季时使用。
- PyCon Australia 2017 的这段视频提供了有关如何整理文档以便于用户发现它的提示: Daniele Procida 所写的没人告诉您有关文档的信息。