参考文档

整理

文档分类

参考文档

参考文档也是大部分开发人员日常会使用和书写的文档,比如我们使用某个框架或者工具,都会有API说明文档,这就属于参考类文档。 它并没有太多的要求,只要能向读者展示清楚如何使用即可,但无需向读者讲明具体的实现。

注:参考文档并不仅限于API文档,还包括文件注释、类注释、方法注释,要求都是能准确说明其用法。

设计文档

很多公司或者团队在项目开始前都要求有设计文档,设计是项目实施的第一步,所以在设计文档书写的过程中要求尽可能考虑周全,例如该项目的存储、交互、隐私……

好的设计文档应该包含以下几个部分:

  1. 设计目标
  2. 实现的策略
  3. 各种利弊权衡和具体决策
  4. 替代方案
  5. 各种方案的优缺点