改进开源硬件文档的 3 种方法

文档是任何开源项目的重要基础,用于指导您的社区并保持其开放性。
82 位读者喜欢这个。
Computer hardware parts

开源硬件月由 Open Source Hardware Association (OSHWA) 每年十月组织,今年,我们将重点关注如何向世界宣告您的项目是开源的。在这个月里,通过以下三种方式加强您的文档,以帮助支持开源硬件生态系统。

文档化

如果您有一个尚未开源的项目,或者您现有的文档可以进行改进,那么现在是时候了!清晰的文档可以帮助潜在用户找到、构建您的项目,并可能为您的项目做出贡献。添加图片、修复损坏的链接以及上传 辅助设计文件 都是使您的项目更易于访问的方法。

在发布文档时,您需要指定许可证,因为版权是自动适用的。例如来自 Creative Commons 的许可证将授予其他人分发和修改您的文档的自由。为了符合开源硬件的 社区定义,许可证不得包含非商业或禁止衍生条款。

发布您的文档还可以通过建立现有技术来防止未来的专利。如果其他人为类似设计申请专利,您的文档可以帮助将您的工作确立为原始设计,并阻止专利获得批准。

标签

您是否曾经发现一个看起来是开源的令人愉快的项目,但却找不到任何许可证?开源硬件许可证标签 可帮助您使用类似于美国营养成分标签的格式声明项目中使用的许可证。在一个突出的位置(例如您存储库的 README)列出您的许可证,可以帮助用户立即了解他们可以对源代码做什么和不能做什么,而无需浏览各个文件。这是对 OSHWA 认证的一个有益的补充,尽管是可选的。

认证

您可能偶然发现过一些项目,它们宣传自己是开源的,但实际上却缺少大部分源代码。OSHWA 认证 通过为产品符合开源硬件定义的创作者提供一种添加带有唯一标识符的认证标志的方式,来解决这个问题(有时称为“开源漂白”)。此标志让用户和客户确信该产品确实是开源的,并且他们能够研究、修改和分发源代码。认证计划还提供了一个 目录,其中包含经过认证的项目,您可以在其中查找特定项目的详细信息或搜索要在您的下一个项目中使用的组件。感谢 200 多位创作者,这个目录最近超过了 1,000 个认证项目!

如果您的项目是开源的,您应该自豪地在屋顶上大声疾呼,而文档实际上是做到这一点的完美方式。您记录得越多,文档越清晰,您就越能为您的项目及其社区提供合法性和保护。它有助于新手确切地了解他们正在使用什么,并确保项目保持开放。还有什么更好的方式来庆祝开源硬件月呢?

接下来阅读什么
标签

评论已关闭。

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