良好的文档——包括安装指南、用户指南、白皮书、常见问题解答等——为用户提供了使用软件和硬件的路线图。 我们的文章侧重于为开源项目创建者提供改进文档质量和实用性的方法。
了解一种基于用户故事的模块化文档的新方法,以及它如何简化作者的工作并改善用户体验。
DocBook 易于学习,易于编写,并且可以执行其他文本标记语言无法执行的操作。
尝试使用这种简单的技术来编写消息,以帮助用户理解错误的原因。
发布文档时,不要冒险遗漏任何东西,无论大小。 以下是如何编写有效的清单以最大限度地减少错误。
文档驱动的开发将您的代码集中到应用程序预期工作方式的特定蓝图上。
编写代码并不比编写文档难,这只是一种不同的技能。