用户工具

站点工具


开发经验

这是本文档旧的修订版!


如何写一篇开发文档

  1. 需求整理
    1. 需求背景
    2. 需求归纳
    3. 现状整理
    4. 要做的事情
  2. 接口设计(给外部调用的接口)
  3. 测试(测试是用代码描述需求)
    1. 接口功能测试用例
    2. 接口性能测试用例
  4. 详细设计(关于怎样实现外部接口的描述)
    1. 术语表
    2. 过程视图
    3. 类和接口(这里是设计模式的舞台)
    4. 关键技术点(提前解决一些技术难点,尽量排除风险)
    5. 性能推演(新功能可能造成的性能影响)
    6. 数据升级(如果对现有数据库中的数据结构有影响,需要给出升级方案)
    7. 安装部署
  5. 开发计划
    1. Milestone
    2. 前置依赖事项
  6. 交付物
    1. 代码(接口&实现)
    2. 工具(代码编译后的产物,可直接使用)
    3. 使用手册
    4. 测试报告
    5. 已知问题
开发经验.1583121296.txt.gz · 最后更改: 2020/03/02 11:54 由 plough

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki