项目创意

当前阶段
文档制作。请参阅时间表

本页面适用于处于组织申请流程探索阶段的开源组织。这些项目创意只是示例,用于展示组织可能如何在组织的项目创意页面上描述可能的文档项目;组织可以提出此列表未包含的项目。

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

问题

  • 新的贡献者将找不到对我们的项目做出有意义的贡献所需的设置信息。某些流程(如协助我们的测试)根本未载明。

如何衡量成效?

  • 新贡献者数量有所增加
  • 增加新的非代码贡献者(使他们能够更轻松地为文档或测试贡献代码)
  • 新贡献者提出的问题数量有所减少
  • 标记为“好的首个问题”的已关闭问题的数量有所增加

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

  • 必须具备:熟悉 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/open 问题或在论坛中提问。请添加指向您的技术写作作品或作品集/简历/简历的链接。

项目创意:进行文档审核

问题

  • 我们对文档的状态并不了解!很难优先改进文档,因为我们没有路线图,也不知道最紧急的问题是什么。我们还有一些 应删除或存档的过时内容。

如何衡量成效?

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

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

  • 建议事项:拥有文档审核经验

志愿者

鼓励社区成员注册来帮助完成特定任务,例如

  • @JaneQCoder 可帮助协调在我们的社区会议中展示文档路线图

联系信息

  • 有兴趣参与此项目的技术文档工程师应该发送电子邮件至 email@project/open 问题或在论坛中提问。请添加指向您的技术写作作品或作品集/简历/简历的链接。
  • 宣传和媒体页面包含您在谈论 Google 文档季时可以使用的徽标和其他内容。
  • PyCon Australia 2017 中的这个视频提供了有关如何整理文档的提示,以方便人们发现文档: Daniele Procida 的没有人告诉您有关文档的信息