完美的软件工程文档范例

目录

1. 范围.............................................................................................................................................1

2. 总体要求.....................................................................................................................................1

2.1 总体功能要求.......................................................................................................................1

2.2 软件开发平台要求...............................................................................................................1

2.3 软件项目的开发实施过程管理要求...................................................................................2

2.3.1

软件项目实施过程总体要求

........................................................................................2

2.3.2

软件项目实施变更要求

................................................................................................2

3.1.4

需求报告格式

3.2 软件的概要设计...................................................................................................................4

3.2.1

概要设计

........................................................................................................................4

3.2.2

编写概要设计的要求

3.2.3

概要设计报告的编写者

................................................................................................4

3.2.4

概要设计和需求分析、详细设计之间的关系和区别

3.2.5

概要设计的评审

3.2.6

概要设计格式

3.3 软件的详细设计...................................................................................................................5

3.3.1

详细设计

........................................................................................................................5

3.4.1

软件编码

........................................................................................................................5

3.4.2

软件编码的要求

3.4.3

编码的评审

3.4.4

编程规范及要求

3.5 软件的测试...........................................................................................................................6

3.5.1

软件测试

........................................................................................................................6

3.5.2

测试计划

........................................................................................................................6

3.6 软件的交付准备...................................................................................................................6

3.6.1

交付清单

........................................................................................................................6

3.8.1

系统应用培训

3.8.2

系统管理的培训（可选）

............................................................................................8

1. 引言...........................................................................................................................................15

1.1 编写目的.............................................................................................................................15

1.2 项目风险.............................................................................................................................15

1.3 文档约定.............................................................................................................................15

1.4 预期读者和阅读建议.........................................................................................................15

1.5 产品范围.............................................................................................................................16

1.6 参考文献.............................................................................................................................16

2. 综合描述...................................................................................................................................16

3. 外部接口需求...........................................................................................................................18

3.1 用户界面.............................................................................................................................19

3.2 硬件接口.............................................................................................................................19

3.3 软件接口.............................................................................................................................19

3.4 通讯接口.............................................................................................................................20

4.1 说明和优先级.....................................................................................................................21

4.2 激励／响应序列.................................................................................................................21

4.3 输入／输出数据.................................................................................................................21

5. 其它非功能需求.......................................................................................................................22

5.1 性能需求.............................................................................................................................22

6. 词汇表.......................................................................................................................................23

8. 分析模型...................................................................................................................................24

9. 待定问题列表...........................................................................................................................25

1. 引言...........................................................................................................................................32

1.1 编写目的.............................................................................................................................32

1.2 项目风险.............................................................................................................................32

1.3 预期读者和阅读建议.........................................................................................................32

1.4 参考资料.............................................................................................................................32

2. 设计概述...................................................................................................................................33

2.1 限制和约束.........................................................................................................................33

2.2 设计原则和设计要求.........................................................................................................33

3. 系统逻辑设计...........................................................................................................................34

3.1 系统组织设计.....................................................................................................................34

3.2 系统结构设计.....................................................................................................................35

4. 系统出错处理设计...................................................................................................................38

4.1 系统出错处理表.................................................................................................................38

4.2 维护处理过程表.................................................................................................................39

5. 技术设计...................................................................................................................................40

5.1 系统开发技术说明表.........................................................................................................40

5.2 开发技术应用说明.............................................................................................................41

6. 数据库设计...............................................................................................................................41

7. 词汇表.......................................................................................................................................42

8. 进度计划...................................................................................................................................42

1. 引言...........................................................................................................................................49

2. 支撑环境...................................................................................................................................50

2.3 硬件环境.............................................................................................................................52

2.4 网络环境.............................................................................................................................52

2.5 多种支撑环境开发要点.....................................................................................................52

3. 部件详细设计...........................................................................................................................52

4. 词汇表.......................................................................................................................................54

5. 部件表格式...............................................................................................................................54

6. 界面表格式...............................................................................................................................55

1. 引言...........................................................................................................................................64

1.1 编写目的.............................................................................................................................64

1.2 项目来源.............................................................................................................................64

2. 数据库命名规则.......................................................................................................................65

3.1 数据库逻辑设计.................................................................................................................65

3.4 基表设计.............................................................................................................................66

3.9 触发器设计.........................................................................................................................70

3.10 存储过程设计...................................................................................................................71

3.11 数据复制设计...................................................................................................................71

4. 词汇表.......................................................................................................................................72

5. 历史数据处理...........................................................................................................................73

1. 引言...........................................................................................................................................80

1.1 目的.....................................................................................................................................80

1.2 术语.....................................................................................................................................80

1.3 参照标准.............................................................................................................................80

2. 测试日期安排...........................................................................................................................81

4. 测试具体内容...........................................................................................................................81

4.2.1

必须提供检查的文档

4.2.2

其他可能需要检查的文档

..........................................................................................82

4.2.3

由业主确定必须检查的其他文档

..............................................................................82

4.3.2

软件一致性检查

4.4.2

可用性测试

4.4.3

功能测试

......................................................................................................................84

4.4.4

稳定性

(

4.4.5

性能测试

......................................................................................................................85

4.4.6

强壮性

(

4.4.7

逻辑性测试

4.4.8

破坏性测试

4.4.9

安全性测试

5. 测试结果交付方式...................................................................................................................85

附录 A 软件需求分析报告文档模板.............................................................................................9

附录 C 软件详细设计报告文档模板...........................................................................................33

附录 D 软件数据库设计报告文档模板.......................................................................................43

附录 E 软件测试(验收)大纲 ....................... ERROR: REFERENCE SOURCE NOT FOUND 5