如何写一篇开发文档

  1. 需求整理
    1. 需求背景
    2. 需求归纳
    3. 现状整理
    4. 要做的事情
  2. 接口设计（给外部调用的接口）
  3. 测试（测试是用代码描述需求）
    1. 接口功能测试用例
    2. 接口性能测试用例
  4. 详细设计（关于怎样实现外部接口的描述）
    1. 术语表
    2. Solution（实现思路）
    3. 过程视图
    4. 关键技术点排坑（提前解决一些技术难点，尽量排除风险）
    5. 类和接口（这里是设计模式的舞台）
    6. 性能推演（新功能可能造成的性能影响）
    7. 数据升级（如果对现有数据库中的数据结构有影响，需要给出升级方案）
    8. 安装部署
    9. 重要假设
  5. 开发计划
    1. Milestone
    2. 前置依赖事项
  6. 交付物
    1. 代码（接口&实现）
    2. 工具（代码编译后的产物，可直接使用）
    3. 使用手册（怎样使用工具的教程）
    4. 测试报告（证明这个工具是可用的）
    5. 已知问题

遗留问题

  1. 怎样做接口设计？什么样的接口是好的接口？有例子吗？
  2. 功能测试用例怎么写？性能测试用例怎么写？怎么保证测试用例覆盖全面？怎么让测试用例自动跑起来？
  3. 过程视图具体有哪些表现形式？主要作用是什么？举例说明？
  4. 性能推演应该怎么做？有没有 best practice？
  5. 使用手册应该包含哪些要素？
  6. 测试报告怎么写？有模板吗？
  7. 全过程中，哪些步骤可以自动化？