===== 如何写一篇开发文档 ===== - 需求整理 - 需求背景 - 需求归纳 - 现状整理 - 要做的事情 - 接口设计(给外部调用的接口) - 测试(测试是用代码描述需求) - 接口功能测试用例 - 接口性能测试用例 - 详细设计(关于怎样实现外部接口的描述) - 术语表 - Solution(实现思路) - 过程视图 - 关键技术点排坑(提前解决一些技术难点,尽量排除风险) - 类和接口(这里是设计模式的舞台) - 性能推演(新功能可能造成的性能影响) - 数据升级(如果对现有数据库中的数据结构有影响,需要给出升级方案) - 安装部署 - 重要假设 - 开发计划 - Milestone - 前置依赖事项 - 交付物 - 代码(接口&实现) - 工具(代码编译后的产物,可直接使用) - 使用手册(怎样使用工具的教程) - 测试报告(证明这个工具是可用的) - 已知问题 ===== 遗留问题 ===== - 怎样做接口设计?什么样的接口是好的接口?有例子吗? - 功能测试用例怎么写?性能测试用例怎么写?怎么保证测试用例覆盖全面?怎么让测试用例自动跑起来? - 过程视图具体有哪些表现形式?主要作用是什么?举例说明? - 性能推演应该怎么做?有没有 best practice? - 使用手册应该包含哪些要素? - 测试报告怎么写?有模板吗? - 全过程中,哪些步骤可以自动化?