良好的文档(包括安装指南、用户指南、白皮书、常见问题解答等)为用户提供了使用软件和硬件的路线图。 我们的文章侧重于为开源项目创建者提供改进其文档质量和实用性的方法。
文档最好是开发过程的一部分。 Sphinx 与 Tox 一起使用,使编写变得容易,外观美观。
在本次对 Matplotlib 首席开发人员 Tom Caswell 的采访中,了解更多关于大规模文档的信息。
技术考虑因素不是判断一个好的翻译平台的最佳方式。
通过记录你已经学到的最有用的东西,更快地解决未来的问题。
在 Ansible 中,文档就是剧本,因此文档会随着代码自然地演变
以最适合您的方式创建文档。