Open source 开源项目的登录页上应该有什么?
问这个问题的原因是为了更好地了解如何为我自己的项目展示一个开源项目。如何才能最好地使项目吸引潜在的新用户和/或开发人员?显然,项目的性质和范围各不相同,因此在回答时,可能有必要根据这些因素对任何建议进行限定Open source 开源项目的登录页上应该有什么?,open-source,webpage,Open Source,Webpage,问这个问题的原因是为了更好地了解如何为我自己的项目展示一个开源项目。如何才能最好地使项目吸引潜在的新用户和/或开发人员?显然,项目的性质和范围各不相同,因此在回答时,可能有必要根据这些因素对任何建议进行限定 它也将是有趣的,看到一些最好的展示项目的好例子在那里 以下是我在开源项目的登录页上查找的一些内容,大致按优先级排序 电梯俯仰:这个软件做什么 下载最新版本的链接 最新消息;新版本有什么新内容 文档链接 链接到讨论板/邮件列表/bug跟踪器;如何谈论它并报告问题 链接到源代码/版本控制系统
它也将是有趣的,看到一些最好的展示项目的好例子在那里 以下是我在开源项目的登录页上查找的一些内容,大致按优先级排序
- 电梯俯仰:这个软件做什么
- 下载最新版本的链接
- 最新消息;新版本有什么新内容
- 文档链接
- 链接到讨论板/邮件列表/bug跟踪器;如何谈论它并报告问题
- 链接到源代码/版本控制系统
- 概述或概述其作用(音高)
- 一些核心功能的截图或示例
- 下载最新版本或源代码的清晰可见链接
- 链接到您的SCM存储库&如何贡献
- 链接到API文档
- 问题跟踪器链接
- 下载你的应用程序
- 了解应用程序的功能(项目描述、屏幕截图)
- 获取帮助和文档
- 如何报告错误
- 如何访问源代码并作出贡献 我要做的是在第一页有一个巨大的下载链接,并简要描述你的程序(最多1-2段)。然后应该在明显的地方有一个链接较长的描述;论坛/邮件列表和文件;以及如何贡献和报告bug 根本原因 为什么先下载链接而不是项目描述 您的用户可能来自两个来源:
- 介绍您的项目或项目公告论坛的文章
- 搜索引擎 在这两种情况下,他们很可能在登录到您的页面之前就已经知道了您的项目。在第一种情况下,他们已经阅读了文章;在第二种情况下,他们正在搜索与您的项目类似的工具 然而,对于第二种情况,他们可能仍然不确定您的项目是否真的是他们所寻找的;这就是为什么要在下载链接的一侧添加一个简短的项目描述。这是为了确保你的项目是/不是他们正在寻找的 为什么是“帮助和文档”、“错误报告”,然后是“贡献” 这是用户在您的程序出现问题时所执行的顺序。首先,他们会查看帮助和文档,然后可能会在论坛上询问一些人;否则,现在他们将提交错误报告或功能请求;然后,如果没有人对bug报告/特性请求感兴趣,那么一些人就会愿意贡献 您可以从以下方面获得想法:
- 开放办公室:
- 火狐:
- Sourceforge:
- 谷歌代码:
- 解释它的作用,也可能通过解释它解决的问题。如果你能用2-3句话用大号字体(介于堆栈溢出问题标题和实际问题文本之间)完成这项工作,那就更好了,你可以链接到“了解更多”页面进行深入研究
使下载副本和开始使用变得非常容易。(一个大的“立即下载”链接很好。MoFo在Get Firefox网站上做得很好,这种模式已经得到了适当的传播。如果是一个包安装,例如Ruby gem,请详细说明步骤。)
显示人们可以去哪里提问和/或文档。你有文件,对吗?(或者你正在做这件事?)
除此之外,还要链接到必要的内容:要浏览的代码库、更详细的“关于”页面(可能是文档的一部分)、贡献者列表(也可能是文档的一部分),但最重要的是尽可能简洁地回答原因和方式
基本上就是这样。您的第一页是演示文稿的第一张或两张幻灯片。您项目的用户对这些内容感兴趣,按纯粹主观重要性排序: