阅读文档使文档变得容易

在Doc Dish专栏中 ，我们通常专注于编写文档，但这还不是全部。 如果他们写了整个文档而没有读者，那么作家将从中受益吗？ 编写文档后，文档必须先出现在用户面前，然后才能阅读。 对于简单的自述文件以外的任何内容，这都是一个挑战。 文档编写者通常需要设计，托管基础结构，搜索工具等。 一个项目旨在使这一过程变得容易一些。

“阅读文档”是一个开源项目（由MIT许可），始于2010年Django Dash。 该项目的目标是通过减少障碍来提高文档的数量和质量。 尽管“阅读文档”无法为您编写文档，但它确实可以自动从源代码管理系统进行构建。 文档以HTML和PDF格式呈现，并且包括全文搜索。

成千上万个开源项目将其文档托管在“ 读取文档”站点上 ，而其他项目则使用“ 读取文档”代码进行自我托管。 此外，该团队已开始为商业和私人用途提供付费服务。

阅读文档解决了很多问题，为什么不使用它呢？ 主要原因是，如果您使用除重组文本之外的其他方式来编写文档。 阅读文档使用Sphinx进行渲染，因此在Sphinx支持其他标记语言之前，您的选择将受到限制。 所有希望都不会丢失：“阅读文档”团队为Sphinx 添加了CommonMark支持 ，因此，如果您愿意，可以添加所需的任何语言。

当然，还有其他方法可以帮助阅读文档。 最紧迫的需求是支持和运营团队中的其他人员。 支持团队成员可通过GitHub问题帮助用户诊断和解决问题。 运营团队轮流待命，以保持站点24/7全天候运行。 有关这些贡献的更多信息，请参见“ 团队”页面 。 通过定期向可持续发展活动 订阅金牌或一次性捐款也可以提供财务支持。

使用“阅读文档”，没有更多的借口可以使您的文档不在用户可以找到的地方发布。

您有分享“阅读文档”的经验吗？ 在评论中让我们知道，或提交Doc Dish文章提案 。

翻译自: https://opensource.com/business/16/8/introduction-read-docs