良好的文档——包括安装指南、用户指南、白皮书、常见问题解答等等——为用户提供使用软件和硬件的路线图。 我们的文章着重于为开源项目创建者提供改善其文档质量和实用性的方法。
您可能听说过结对编程,但结对写作呢? 以下是一个伙伴如何帮助您的文档焕发光彩。
糟糕的文档是迄今为止 Linux 用户苦恼的主要原因。 以下是其他一些常见问题领域。
为什么这么多组织难以创建清晰、有凝聚力的文档? 以下是如何避免常见的文档错误。
最好的技术文档与读者的需求同步。 您如何才能做到这一点?
想要编写更好的项目文档? 本指南可帮助您升级。
认为您不需要或负担不起文档审核? 再想想。 您可能负担不起不审核的后果。