好的文档—包括安装指南、用户指南、白皮书、常见问题解答等等—为用户使用软件和硬件提供了路线图。 我们的文章着重于为开源项目创建者提供改进其文档质量和实用性的方法。
使用维基进行文档编写并不是什么新主意。 无数的开源项目都这样做。 如果您正在寻找一种快速编写和发布文档的方法，维基可能是一种...
技术文档的某些趋势非常突出。 我们总结了 2016 年的五大趋势。
当人们使用您的软件时，他们试图完成一个目标。 他们试图解决问题、找到自动取款机、抓住 Leafeon。 他们通常不是因为...而使用软件
所以您已经编写了一些优秀的文档。 现在怎么办？ 现在是时候回去编辑它了。 当您第一次坐下来编写文档时，您想专注于...
Markdown 是开发人员和非开发人员中最流行的文档格式之一。 它易于编写和理解，但组织 Markdown 文档很困难。 在…
今年早些时候，我描述了优秀文档的三个重要特征：简洁、一致和简单。 我写道，良好的措辞对于...
