开源帮助文档冲刺营的 5 个经验教训

尚无读者喜欢这篇文章。
Typewriter keys

原始照片由 mshipp 拍摄。由 Rikki Endsley 修改。 CC BY-SA 2.0 许可。

冲刺营是围绕开源文档项目建立势头和社区的最有效工具之一。在过去的四年里,Open Help Conference & Sprints 为许多著名的开源项目举办了文档冲刺营,并且通常是项目的第一个冲刺营举办地。Open Help 在 2015 年庆祝其五周年,场地升级并为六个文档冲刺营提供空间。

Open Help 具有独特的形式,包括演示文稿以及与会者主导的公开讨论。开源项目面临独特的挑战,讨论形式允许人们就从内容规划到社区建设等所有问题提问和分享解决方案。

但也许更重要的是,Open Help 为开源项目举办为期三天的文档冲刺营。Open Help 处理所有后勤工作,让人们可以专注于他们的内容和社区。更重要的是,与其他项目一起举办冲刺营提供了向其他团队学习最佳实践的机会。

过往冲刺营

在第一年,Open Help 为 GNOMEMozilla 举办了冲刺营。GNOME 和 Mozilla 之前都举办过冲刺营,但次数不多。当时开源文档冲刺营还很新颖,观察不同的团队动态很有趣。Mozilla 贡献者通常很安静,勤奋地写作,主要为了评审而互动。另一方面,GNOME 贡献者花费大量时间进行计划和头脑风暴。两个团队都富有成效,并且都继续举办了更多冲刺营并改进了他们的流程。

2012 年,Open Help 为 GNOME、FreeBSDWebPlatform.org 举办了冲刺营。事实上,Open Help 2012 发生在 WebPlatform.org 甚至发布之前。来自 Mozilla、Google、Microsoft 和 W3C 的社区成员齐聚一堂,计划为 Web 作为开发平台制定权威参考。这是一个协作与合作的绝佳范例,来自多家公司和组织的贡献者,他们已经维护着自己针对 Web 的参考站点。

2013 年,GNOME 和 FreeBSD 再次回归,WordPress 和 Wikipedia 以及一位 Mozilla 贡献者也加入了进来。Wikipedia 团队为 Wikipedia 的帮助页面创建了最佳实践指南,并将他们在会议期间学到的知识应用于 Wikipedia 茶馆,这是一个为新编辑提供的支持空间。此外,来自 OpenMRS 的主要贡献者参加了第一天的冲刺营,以规划他们的文档。

去年,GNOME、FreeBSD 和 Mozilla 的贡献者再次回归。GNOME 团队首次将其重点从用户帮助转移到开发者文档,从而成功推出了 HowDoI 系列开发者教程。

冲刺营技巧

举办成功的文档冲刺营需要一些思考和计划。我参与过非常棒的冲刺营,也参与过完全没有成效的冲刺营。没有一个适用于每个社区的完美公式,随着你举办更多冲刺营,你将了解什么最适合你的团队。以下是我多年组织冲刺营并在 Open Help 观察他人冲刺营的经验中获得的一些技巧。

  1. 积极主动。 我见过很多潜在的冲刺营从未发生,因为没有人推动它们发生。在像 GNOME 这样有规律举办冲刺营的项目中,让人们参加是相当容易的。但是如果你的社区成员不习惯参加冲刺营,你可能需要稍微强硬一点才能让他们承诺加入。

    对于志愿者众多的项目来说,资金总是很棘手的。通常基金会或赞助公司有资金帮助贡献者参加冲刺营和其他活动,但组织者面临着先有鸡还是先有蛋的问题:贡献者在没有资金的情况下不会承诺参加,但赞助商在看到与会者名单之前无法承诺资金。确定你想让哪些人参加,并推动他们承诺以资金为条件参加。单独给人们发邮件会有帮助。建立一个包含潜在与会者姓名的 wiki 计划页面,并在申请资金时使用它。

    在像 Open Help 这样的活动中举办冲刺营意味着你无需担心场地费用,但差旅和住宿仍然是需要考虑的问题。

  2. 制定议程。 不要对你要做什么一无所知就走进冲刺营。事先使用邮件列表或 wiki 与其他贡献者交谈,并确定需要做什么。记住,即使是无法参加的人也可以帮助制定冲刺营的议程。

    虽然制定议程很重要,但不要太具体,也不要太严格地遵守它。了解你试图解决的问题以及你试图改进的文档部分是有帮助的。事实上,这通常会影响你最想让谁参加。但是冲刺营有一种带来新想法的方式。不要因为它们不在议程上就害怕遵循它们。

  3. 确保每个人都做好准备。 破坏冲刺营的最快方法之一是花费整个时间让人们准备好做出贡献。如果人们需要安装特定的软件,或者需要熟悉某些技术或流程,请事先告知所有人。有时冲刺营可能是让人们入职的有用方法,在这种情况下,你可能不期望每个人都准备好写作。只需确保设定正确的期望。
  4. 专注于计划。 这不是绝对的。我见过许多成功地专注于写作而不是计划的冲刺营。但在我的经验中,协作计划会议更好地利用了面对面的时间,原因有二。

    首先,写作比计划更容易独自完成。人们回家后可以写得很好,但他们不会像在冲刺营期间一起计划得那么好。密集的写作会议适合虚拟冲刺营,人们不必面对面会面。但是当你们坐在同一个房间里时,更容易找到问题并找出解决方案。

    其次,计划会议建立更好的社区,因为它们往往比写作会议更具互动性。成功的冲刺营既能建立社区,又能创建良好的文档,因为你的社区是每个人回家后你成功的关键。

  5. 一起度过时间。 不同的团队对人们在冲刺营期间工作多长时间有不同的期望。有些团队只工作正常的工作日,而另一些团队则工作到深夜。无论哪种方式,冲刺营参与者都应该尽可能多地在一起度过时间,无论这些时间是用于工作还是娱乐。

    计划一起用餐。根据你的社区成员的舒适度,一起去酒吧或咖啡馆。如果有时间,一起去郊游。在城市里散步,参观博物馆,或去喜剧俱乐部。互相了解。玩得开心。社交联系是你的团队可以创造的最重要的事情。

在 Open Help 举办冲刺营

你可以在任何地点和任何时间举办冲刺营。但 Open Help 是你团队冲刺营的绝佳场所,特别是对于以前没有举办过很多冲刺营的团队。除了举办有趣且富有成效的冲刺营外,你还可以从多年来一直举办冲刺营的团队的集体经验中学习。

如果你对在 Open Help 举办冲刺营感兴趣,请发送电子邮件至 info@openhelp.cc。我们可以帮助你组织一个成功的冲刺营。如果你有任何有趣的东西要分享,你可以提交一份完整演讲的提案,或者只是一个 15 分钟的简报或演示。Open Help 的成功仅仅是因为与会者,我们总是乐于听取新的见解。

文档
专栏

本文是 Rikki Endsley 协调的 Doc Dish 专栏 的一部分。要为本专栏投稿,请提交您的故事想法联系我们

标签
User profile image.
Shaun McCance 在开源开发、文档和社区领导方面有着悠久的历史。他目前在 Red Hat 担任 CentOS 社区架构师,并努力抽出时间继续从事 GNOME 的工作。

评论已关闭。

Creative Commons License本作品根据 Creative Commons Attribution-Share Alike 4.0 International License 许可。
© . All rights reserved.