开发免费和开放软件的好的做法：文档

La 文件 是并且应该是 创作过程和计划 所有人类活动，尤其是在技术领域，尤其是在 软件开发.

El 所有文件的目的 一定是他 教第三方（用户，管理员，维护者或其他开发人员），他们通常不熟悉 产品（代码，应用程序或系统），它是如何创建的 它的结构，它的运作 甚至可能的话，说明其创建的原因及其设计和操作方式。

此外，在特定情况下 免费软件文档至关重要，因为它可以完全保证 知识转移与授权 圆满实现的必要条件 4种自由 由它推动，它们是：

• 0: 出于任何目的自由运行程序的自由。
• 1: 可以自由访问和研究程序，并为自己的利益进行更改或改编。
• 2: 共享或重新分发副本以自由传播和/或帮助他人的自由。
• 3: 将修改版本的副本分发给第三方的自由。

因此，好的文档可以使创建的产品：

• 正确使用它，更容易教授和学习。
• 希望对其进行修改以改进或调整它的人应完全理解。
• 在所有潜在的相识者和陌生人之间更加自信地共享和接受。
• 在公众中有更好的群众。

良好做法：文档

基金会

在的情况下，中 自由软件和开源开发通常 本文档的主要用户 与产品设计相关的是 负责维护 一样的。 没有好的或没有的文档，唯一可行的选择是直接探索它，以实现 了解其设计和功能.

当涉及到时，没有创建好的文档 开发免费软件，开源 或任何其他类型的软件，以发送给其可能的收件人 （用户，管理员，维护人员或其他开发人员） 在没有地图或指南针的丛林中找到一条出路。

为每个创建好的文档 免费软件，开源 这也是有益的，因为尽管 记录有成本如果做得正确，这项投资是值得的。 因为，世界 软件 充满了有关的故事 遗留代码 旧的或当前的程序，应用程序或系统，只有很少的人敢于接触，因为几乎没人能理解。 程序员专注于创建代码，而不是正确和完整地记录它。 这必须予以纠正。

README文本文件中文档的良好做法

在的情况下，中 自由软件和开源，文档通常是由个人或一小群程序员或社区创建的文本文件。 但是，直到使用简单的文档创建简单的文档 文本文件README.md（或.txt） 你可以有你的 最佳或良好做法的提示，技巧或有用的指导，可将有关所创建内容的最完整，最详细的信息带给第三方。

对于我们的文章，我们采用了 好的做法 由...构思和披露 “发展守则倡议= 该 美洲开发银行，以总结的方式告诉我们，基于 文本文件README.md（或.txt） 它的结构必须如下：

推荐的README文件结构

• 描述和上下文： 您必须在其中描述功能，开发环境和帮助解决的开发问题的部分。
• 用户指南： 应在此部分提及最终用户如何开始使用数字工具的说明。
• 安装指南： 应当提及重新使用和配置数字工具的安装说明部分。 本部分面向开发人员。
• 作者 必须归功于工具合作者的部分。
• 工具代码的许可证： 必须在此处指定授予第三方重用数字工具的权限的部分。
• 工具文档的许可证： 必须提及创建的文档中包含的许可证类型的部分。

在这些 良好做法，他们还建议添加到 自述文件文档 为了使它更完整，请参见以下部分：

• 如何贡献： 向新开发者说明为项目做出贡献的过程的部分。
• 行为守则： 解释行为准则的部分建立了个人和组织与数字工具或其社区进行任何交互时必须遵循的社会规范，规则和责任。
• 徽章： 该部分显示徽章（以README.md嵌入的小图像），以简洁易懂的方式指定工具的状态。
• 版： 该部分指示数字工具的版本列表以及添加到每个版本的功能。
• 致谢： 包含对以某种方式对项目做出贡献的其他人员或组织的致谢的部分。

要扩展此信息，请在 好的做法 就...而言 文件 为了发展 自由软件，由 “发展守则倡议= 该 美洲开发银行 您可以单击以下链接： 文档-发布数字工具指南。 在其他出版物中，我们将探讨涉及 良好做法 上 评估和许可 该 免费和开放软件 他们自己。

结论

我们希望 这 “有用的小贴子= 关于 «Buenas prácticas» 在...方面 «documentación» 在开发时创建 «Software libre y abierto»，对于整个 «Comunidad de Software Libre y Código Abierto» 并为传播和应用的奇妙，巨大且不断发展的生态系统做出了巨大贡献 «GNU/Linux».

有关更多信息，请不要总是犹豫访问任何 在线图书馆 如 OpenLibra y 杰迪 读书 书籍（PDF） 关于这个话题或其他 知识领域。 现在，如果你喜欢这个 «publicación», 不要停止分享 与他人，在你的 最喜欢的网站，渠道，团体或社区 社交网络，最好是免费开放的 乳齿象，或者像 Telegram.

或直接访问我们的主页，网址为 DesdeLinux 或加入官方频道 电报 DesdeLinux 阅读此书或其他有趣的出版物并为其投票 «Software Libre», «Código Abierto», «GNU/Linux» 和其他相关主题 «Informática y la Computación»和 «Actualidad tecnológica».