如何写好技术文档 — 来自十多年的文档经验总结
注释、类注释、方法注释,要求都是能准确说明其用法。 ## 设计文档 ## 很多公司或者团队在项目开始前都要求有设计文档,设计是项目实施的第一步,所以在设计文档书写的过程中要求尽可能考虑周全,例如该项目的存储、交互、隐私…… 好的设计文档应该包含以下几个部分: 1. 设计目标 2. 实现的策略 3. 各种利弊权衡和具体决策 4. 替代方案 5. 各种方案的优缺点 写设计文档的过程也你对整个项目做规划、思考可能出现问题的过程,设计的越详细、思考的越多,未来遇到问题的可能性就会越小。 ## 引导类文档 ## 引导类文档也很常见,一般都是Step by Step的形式。比如我们在使用某个框架或者工具的时候,一般都会有个引导类的文档一步一步帮助你快速上手。 大家写引导类文章大家非常容易犯的一个错误就是...阅读全文