当前阶段:
公布结果的时间表。
本页面适用于处于组织申请流程探索阶段的开源组织。这些项目创意只是示例,用于展示组织可能如何在组织的项目创意页面上描述可能的文档项目;组织可以提出未包含在此列表中的项目。
项目构想:制作贡献者新手入门指南
问题
- 新的贡献者将无法找到所需的设置信息,从而无法对我们的项目做出有意义的贡献。某些流程(例如协助我们的测试)根本不会记录。
我们如何衡量成效?
- 新增贡献者数量增幅
- 增加新的非代码贡献者(更轻松地为文档或测试贡献代码)
- 新贡献者提出的问题数量有所减少
- 带有“良好首个问题”标签的已关闭问题的数量有所增加
参与此项目的技术文档工程师需要具备哪些技能?
- 必须具备:熟悉 GitHub(或愿意学习 GitHub 教程)
- 建议条件:熟悉我们的测试运行程序,以便运行测试并更新相关文档
志愿者
鼓励社区成员注册,以帮助完成特定任务,例如:
- @JaneQDev 可以帮助回答有关测试的问题
- @ChenPCoder,我很乐意查看文档拉取请求
- @ErichJEngineer,可以与技术文档工程师一起详细了解当前的贡献流程
联系信息
- 有兴趣参与此项目的技术文档工程师应该发送电子邮件至 email@project。请添加指向您的技术写作或作品集/简历/履历的链接。
项目创意:编写教程,以便结合使用我们的库 ...
问题
- 用户尝试通过 $TechnologyX 使用我们的库时,我们的项目会引发许多问题。我们没有关于与 $TechnologyX 集成的明确指南,这可能非常棘手!
我们如何衡量成效?
- 带有“$TechnologyX”标签的问题数量有所减少
- 来自帮助我们修复 bug 或向 $TechnologyX 相关文档中添加内容的新贡献者的拉取请求数量有所增加
- $TechnologyX 项目中更多指向我们项目的链接
参与此项目的技术文档工程师需要具备哪些技能?
- 建议条件:对 $TechnologyX 有一定的了解
志愿者
鼓励社区成员注册,以帮助完成特定任务,例如:
- @JaneQDev,可以帮助回答与 $TechnologyX 相关的问题
- @ChenPCoder,我很乐意查看文档拉取请求
联系信息
- 有兴趣参与此项目的技术文档工程师应该发送电子邮件至 email@project。请附上指向您的技术写作或作品集/简历/履历的链接。
项目创意:重新整理我们的文档
问题
- 我们的文档杂乱无章,杂乱无章。许多用户放弃了在文档中查找答案,只是在我们的论坛中提出问题或提问。即使对于相关的关键字,我们的网页也不会显示在搜索结果中。
我们如何衡量成效?
- 为文档提供更好的搜索引擎优化 (SEO)
- 针对文档涵盖的主题提出的问题数量有所减少
- 文档贡献数量增加
参与此项目的技术文档工程师需要具备哪些技能?
- 建议做法:拥有重新整理大型且成熟的文档集的经验,了解 SEO
志愿者
鼓励社区成员注册,以帮助完成特定任务,例如:
- @ChenPCoder,我很乐意查看文档拉取请求
联系信息
- 有兴趣参与此项目的技术文档工程师应该发送电子邮件至 email@project。请附上指向您的技术写作或作品集/简历/履历的链接。
项目创意:运行文档修复程序
问题
- 我们有很多与文档相关的小错误和老问题。我们的社区非常乐意提供帮助,并帮助解决问题,但我们需要有人来组织和运行实际的修复。
我们如何衡量成效?
- 已关闭的文档相关问题数量
- 文档贡献数量和新贡献者数量不断增加
参与此项目的技术文档工程师需要具备哪些技能?
- 建议内容:具备运行文档修复的经验
- 出色的组织能力
志愿者
鼓励社区成员注册,以帮助完成特定任务,例如:
- @ChenPCoder,他可以帮助组织修复视频和聊天内容,以及帮助寻找位于其他时区的志愿者
联系信息
- 有兴趣参与此项目的技术文档工程师可发送电子邮件至 email@project/提问/在我们的论坛中提问。请附上指向您的技术写作作品或作品集/简历/CV 的链接。
项目创意:进行文档审核
问题
- 我们对文档的状态并不了解!很难优先改进文档,因为我们不了解路线图,也不知道最紧急的问题是什么。我们还有许多应删除或归档的过期内容。
我们如何衡量成效?
- 创建文档路线图并获得社区普遍批准
- 过期或不正确的文档页面数量减少
参与此项目的技术文档工程师需要具备哪些技能?
- 建议条件:有文档审核经验
志愿者
鼓励社区成员注册,以帮助完成特定任务,例如:
- @JaneQCoder 可以帮助协调如何在社区会议中展示文档路线图
联系信息
- 有兴趣参与此项目的技术文档工程师可发送电子邮件至 email@project/提问/在我们的论坛中提问。请附上指向您的技术写作作品或作品集/简历/CV 的链接。
相关信息
- 宣传和媒体页面包含徽标和其他内容,您可以在谈论文档剧季时使用。
- PyCon Australia 2017 的这段视频提供了有关如何整理文档以便于用户发现它的提示: Daniele Procida 所写的没人告诉您有关文档的信息。