Please enable JavaScript.
Coggle requires JavaScript to display documents.
项目文档编写指南 (分类 (系统设计文档 (要点 (架构 (概念模型, 结构,行为,其他), 模块, 接口, 数据), 分类 (详细设计文档…
项目文档编写指南
分类
需求分析文档
可能包含的内容
背景和目标
假设和依赖
功能描述
使用场景描述
对外提供的接口定义
约束限制
错误
同系统设计文档混在一起
不从用户角度出发思考功能和场景,而从实现角度考虑怎么做简单
子模块的背景目标写成了所属大项目的
系统设计文档
要点
架构
概念模型
结构,行为,其他
模块
接口
数据
分类
总体设计文档
详细设计文档
子系统设计文档
关键算法设计文档
测试评价文档
对系统的性能、功能等方面测评的记录和分析
错误
只讲结果,不说原因
只有系统组成,没有关键机制和算法