一个开源项目的网站是潜在用户和贡献者了解您的项目的主要入口,它也帮助现有社区成员为项目做出贡献。但它必须做得正确。 您的网站是否清晰地展示了您的项目、其目标和状态,并帮助您的社区成员高效地相互沟通?它是否正在吸引新的贡献者?
本文基于 oVirt 社区网站的开发经验,分享了构建社区网站的各个方面。
oVirt 是一个虚拟数据中心管理平台,因其强大的社区而备受赞誉。oVirt 的网站是这种优势的一部分,但仍需要改进。目前,该网站基于 MediaWiki,这未能充分支持 oVirt 网站提升到更高水平,成为真正有效且动态的社区网站。社区正处于为 oVirt.org 规划新平台和新“外观和感觉”的早期阶段,随着新网站的规划和旧网站的审查工作正在进行中,我想分享一些关于如何提高开源社区网站吸引新贡献者以及简化现有社区成员工作和沟通的想法和建议。
使其成为家
毫无疑问,主页是您网站访问量最高的页面,因此必须满足明确的指导原则。
确保主页用简短的几句话清晰地介绍和解释项目。项目的目标/主题是什么?换句话说,项目是做什么的?当前的稳定版本是什么,何时发布的?
应该有一个清晰而简单的“联系方式”部分,最好带有易于识别的图标。如果您有 IRC 频道、邮件列表或任何社交媒体存在(即 Twitter、Facebook、Google+ 等),那么这里就是展示它们的地方。如果有几个不同的 IRC 频道或邮件列表,最好简要说明每个邮件列表或 IRC 频道的用途/目标受众。
说到邮件列表,最好不要有太多。二十个邮件列表可能会让任何社区新手感到困惑。较少的邮件列表(和其他沟通渠道)将使新手更容易联系并提出问题。这也将向参与者表明,项目乐于沟通,并方便现有贡献者的持续沟通。
考虑将指向您相关帐户的社交媒体图标放在顶部菜单中。这种做法在当今许多网站上已变得非常普遍,并且对用户来说是直观的。
如果已经有现有的客户故事或案例研究,请考虑将他们的徽标放在故事中,并链接到另一个页面,讲述他们如何使用该项目。如果您没有案例研究,您可能需要添加一些。
如果您的项目有聚会,或者在即将到来的活动中有展位或演讲,请在“即将举行的活动”部分提及,并链接到相关活动,注明日期和地点。
“新闻源”将表明项目是“活跃的”而不是“被遗弃的”。它可以采用嵌入提及该项目的 Twitter 源,或任何其他带有日期和项目简短更新的“最新消息”部分的形式。
超越主页
您不仅要担心房屋的前门。以下是针对网站其余部分的一些建议。
务必明确说明如何以及在哪里报告错误。顶部菜单选项或大而清晰可见的按钮是不错的选择。报告错误与您项目的所有受众、用户和开发人员相关。
制作一个明显的下载菜单或包含以下信息的页面:可以从哪里下载项目工件?安装步骤是什么?最低硬件和软件要求是什么?还需要考虑:您是否只想发布当前版本的下载说明和工件,还是也发布几个旧版本?
文档是任何社区的巨大资产。链接到用户文档,其中解释了软件的主要功能,并附带屏幕截图和示例输入。确保您拥有易于搜索的功能页面,并标记主要项目功能和相关发布号/版本的描述——包括已发布的版本和正在开发中的版本。这样,用户和开发人员将能够了解项目的路线图。
开发人员需要特别照顾。一个良好且清晰的面向开发人员的部分通常可以为项目带来更多贡献者。以下是此部分的一些想法,包括
- 指向源代码的链接以及文档完善的从源代码构建步骤。
- 项目的技术栈是什么——使用了哪些编程语言?主要框架/组件/高级架构是什么?对技术栈进行清晰而简短的陈述可以节省新来者的时间,当他们不确定是否可以根据他们的技术知识和他们有兴趣使用和学习的语言/框架为项目做出贡献时。即将到来的社区成员当然也可以从源代码中理解它,但这肯定会更耗时浏览源代码。
- 补丁的代码审查流程是什么,代码审查使用什么工具?还要务必提及谁是主要维护者及其责任领域。
- 链接到一个带有简单/入门级开放错误的过滤器,可以帮助新手熟悉代码,他们可以在此过程中帮助解决一些错误。
博客是分享有关新版本发布、新功能和过去活动图片的新闻和更新的好方法。确保从主菜单清晰链接到博客,并在博客文章上添加标签以方便搜索。沿着这些思路,确保整个网站都可搜索,并且搜索框在每个页面上都清晰可见,尤其是在主页上。
最后,思考如何维护网站本身的变化。如何才能轻松地提交对网站的更改?例如,添加新的功能页面或修复文档中的错别字。谁应该审查和批准这些更改?用户应该具备哪些工具和技能?他们应该了解 git 并将其作为补丁提交吗?这可能是可行的,但可能太复杂了,特别是对于非开发人员用户而言。是否有更好更简单的工具来实现这一点?
网站技术使实现满足开源社区需求的功能变得容易,但是为您的社区选择合适的工具和设计正确的网站结构需要时间和周全的考察。
最初以 充分利用您的开源项目网站 为标题发表于 Red Hat 开发者博客。
评论已关闭。