项目创意

当前阶段
文档开发。请参阅时间轴

本页面适用于处于组织申请流程探索阶段的开源组织。这些项目想法仅供参考,旨在展示组织如何在其项目想法页面上描述可能的文档项目;组织可以提议不在此列表中的项目。

项目想法:创建贡献者新手入门指南

问题

  • 新贡献者找不到为我们的项目做出有意义贡献所需的设置信息。某些流程(例如对我们的测试做出贡献)根本没有记录。

我们如何衡量成效?

  • 新贡献者数量增加
  • 增加非代码贡献者的数量(通过简化文档或测试的贡献方式)
  • 减少新贡献者提出的问题数量
  • 标记为“良好第一个问题”的已解决问题的数量有所增加

技术文档工程师需要具备哪些技能才能完成这个项目?

  • 必备条件:熟悉 GitHub(或愿意学习 GitHub 教程)
  • 建议条件:熟悉我们的测试运行程序,以便运行测试并更新相关文档。

志愿者

鼓励社区成员注册以帮助执行特定任务,例如

  • @JaneQDev,可以帮助解答有关我们测试的问题
  • @ChenPCoder,很高兴能审核文档拉取请求
  • @ErichJEngineer,可以与技术文档撰写人员一起介绍当前的贡献流程

联系信息

  • 有兴趣参与此项目的技术文档工程师应发送电子邮件至 email@project。添加指向您的技术写作作品或作品集/简历/履历的链接。

项目想法:编写教程,介绍如何将我们的库与 ... 搭配使用

问题

  • 我们的项目收到了许多用户在尝试将我们的库与 $TechnologyX 搭配使用时遇到的问题。我们没有关于如何与 $TechnologyX 集成的明确指南,而且可能会很棘手!

我们如何衡量成效?

  • 标记为“$TechnologyX”的问题数量减少
  • 新贡献者提交的拉取请求数量增加,帮助我们修复 bug 或添加 $TechnologyX 相关文档
  • 更多指向 $TechnologyX 项目的链接

技术文档工程师需要具备哪些技能才能完成这个项目?

  • 建议条件:对 $TechnologyX 有一定的了解

志愿者

鼓励社区成员注册以帮助执行特定任务,例如

  • @JaneQDev,可以帮助解答有关 $TechnologyX 的问题
  • @ChenPCoder,很高兴能审核文档拉取请求

联系信息

  • 如果有技术文案撰写者有意参与此项目,请发送电子邮件至 email@project。包含指向您的技术写作作品或作品集/简历/履历的链接。

项目创意:重新整理我们的文档

问题

  • 我们的文档内容繁杂且杂乱无序。许多用户放弃了尝试在文档中查找答案,而只是在我们的论坛中提出问题或提问。我们的网页未出现在搜索结果中,即使使用相关关键字也是如此。

我们如何衡量成效?

  • 改进了文档的 SEO
  • 减少针对文档中涵盖的主题提出的问题数量
  • 文档贡献数量增加

技术文档工程师需要具备哪些技能才能参与此项目?

  • 建议条件:拥有重新整理大型和成熟文档集的经验,了解 SEO

志愿者

鼓励社区成员注册以帮助执行特定任务,例如

  • @ChenPCoder,很高兴能审核文档拉取请求

联系信息

  • 如果有技术文案撰写者有意参与此项目,请发送电子邮件至 email@project。包含指向您的技术写作作品或作品集/简历/履历的链接。

项目想法:运行文档修复程序

问题

  • 我们遇到了很多与我们的文档相关的小 bug 和老问题。我们的社区会非常乐意提供帮助,清理这些问题,但我们需要有人来组织和运行实际的修复。

我们如何衡量成效?

  • 已关闭的文档相关问题数量
  • 文档贡献者和新贡献者数量增加

技术文档工程师需要具备哪些技能才能参与此项目?

  • 有助于胜任:有文档修复程序运行经验
  • 出色的组织能力

志愿者

鼓励社区成员注册以帮助执行特定任务,例如

  • @ChenPCoder 可帮助整理视频和聊天以解决修复问题,并帮助寻找其他时区的志愿者

联系信息

  • 有兴趣参与此项目的技术文档工程师应发送电子邮件至 email@project/打开问题或在我们的论坛中提问。添加指向您的技术写作作品或作品集/简历/履历的链接。

项目想法:进行文档审核

问题

  • 我们不太清楚文档的状态!我们很难优先确定文档改进,因为我们没有路线图,也没有对最紧急问题的看法。我们还有许多过时内容需要删除或归档。

我们如何衡量成效?

  • 创建文档路线图,并获得社区的普遍批准
  • 减少过时或不正确的文档页面数量

技术文档工程师需要具备哪些技能才能参与此项目?

  • 优先条件:有文档审核经验

志愿者

鼓励社区成员注册以帮助执行特定任务,例如

  • @JaneQCoder,可以协调在社区会议中展示文档路线图

联系信息

  • 有兴趣参与此项目的技术文档工程师应发送电子邮件至 email@project/打开问题或在我们的论坛中提问。添加指向您的技术写作作品或作品集/简历/履历的链接。
  • 宣传和媒体页面包含徽标和其他内容,可供您在宣传 Google 文档季活动时使用。
  • 以下视频来自 2017 年 PyCon Australia 大会,由 Daniele Procida 讲述,介绍了如何整理文档,以便用户能够轻松使用:关于文档的那些不为人知的秘密