项目文档需要多详细才好?
2011-02-18 16:34
113 查看
需求文档
读者: 所有. 包括:系统使用者, 测试者, 设计者, 开发者
越明确越好
设计文档
读者: 设计者, 开发者
设计文档的目的是让开发者对系统架构有一个大概的了解,并提供对难懂部分的解释. 具体设计还需开发者研究代码.
设计文档不能太详细, 否则代码和文档很难同步
文档只需包括
设计思想, 原则等不经常变的内容
一些很难用语言描述的图表
重要和非常规的设计
一些设计中的假设, 决定取舍, 优劣对比等
读者: 所有. 包括:系统使用者, 测试者, 设计者, 开发者
越明确越好
设计文档
读者: 设计者, 开发者
设计文档的目的是让开发者对系统架构有一个大概的了解,并提供对难懂部分的解释. 具体设计还需开发者研究代码.
设计文档不能太详细, 否则代码和文档很难同步
文档只需包括
设计思想, 原则等不经常变的内容
一些很难用语言描述的图表
重要和非常规的设计
一些设计中的假设, 决定取舍, 优劣对比等
相关文章推荐
- java在线聊天项目 实现基本聊天功能后补充的其他功能详细需求分析 及所需要掌握的Java知识基础 SWT的激活方法,swt开发包下载,及破解激活码
- 项目开发需要些的文档
- 在项目前期需求分析阶段,需要编写的文档
- 【记账小助手】项目文档(包含需要用到的知识点)
- 项目需要,shell脚本自动化替换文档内容,并提交代码 3ff8
- 项目详细设计开发文档
- 一个项目需要提交哪了些文档?
- 我的传智播客毕业设计项目详细设计文档一
- 【记账小助手】项目文档(包含需要用到的知识点)
- 项目管理:为什么我们需要一个需求文档
- 项目开发需要些的文档
- 如何写项目文档--制作word模版详细实践
- “NGNcalc2x项目”详细设计文档:《NGNcalc2x开发手册附件》
- 项目三大文档: 项目章程, 初步的项目范围说明书 ,详细范围说明书,项目计划书
- “NGNcalc2x项目”详细设计文档:《NGNcalc2x开发手册附件》
- 详细设计说明文档-团队项目开发
- 传智播客毕业项目详细设计文档二
- 项目管理中的详细设计文档的编写
- 传智播客毕业项目详细设计文档三
- UML项目应用理解--快速了解整个系统架构和详细设计文档