软件开发所需几种文档的概述

                    可行性分析报告

1  引言  
1.1  编写目的：阐明编写可行性研究报告的目的，提出读者对象。  
1.2  项目背景：应包括  
　　 ●  所建议开发软件的名称  
　　 ●  项目的任务提出者、开发者、用户及实现软件的单位  
　　 ●  项目与其他软件或其他系统的关系。  
1.3  定义：列出文档中用到的专门术语的定义和缩写词的原文。  
1.4  参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括  
　　 ●  项目经核准的计划任务书、合同或上级机关的批文  
　　 ●  与项目有关的已发表的资料  
　　 ●  文档中所引用的资料，所采用的软件标准或规范  
2  可行性研究的前提  
2.1  要求：列出并说明建议开发软件的的基本要求，如  
　　 ●  功能  
　　 ●  性能  
　　 ●  输入 / 输出  
　　 ●  基本的数据流程和处理流程  
　　 ●  安全与保密要求  
　　 ●  与软件相关的其他系统  
　　 ●  完成日期  
2.2  目标：可包括  
　　 ●  人力与设备费用的节省  
　　 ●  处理速度的提高  
　　 ●  控制精度或生产力的提高  
　　 ●  管理信息服务的改进  
　　 ●  决策系统的改进  
　　 ●  人员工作效率的提高  
2.3  条件、假定和限制：可包括  
　　 ●  建议开发软件运行的最短寿命  
　　 ●  进行显然方案选择比较的期限  
　　 ●  经费来源和使用限制  
　　 ●  法律和政策方面的限制  
　　 ●  硬件、软件、运行环境和开发环境的条件和限制  
　　 ●  可利用的信息和资源  
　　 ●  建议开发软件投入使用的最迟时间  
2.4  可行性研究方法  
2.5  决定可行性的主要因素  
3  对现有系统的分析  
3.1  处理流程和数据流程  
3.2  工作负荷  
3.3  费用支出：如人力、设备、空间、支持性服务、材料等项开支  
3.4  人员：列出所需人员的专业技术类别和数量  
3.5  设备  
3.6  局限性：说明现有系统存在的问题以及为什么需要开发新的系统  
4  所建议技术可行性分析  
4.1  对系统的简要描述  
4.2  与现有系统比较的优越性  
4.3  处理流程和数据流程  
4.4  采用建议系统可能带来的影响  
　　 ●  对设备的影响  
　　 ●  对现有软件的影响  
　　 ●  对用户的影响  
　　 ●  对系统运行的影响  
　　 ●  对开发环境的影响  
　　 ●  对经费支出的影响  
4.5  技术可行性评价 : 包括  
　　 ●  在限制条件下，功能目的是否达到  
　　 ●  利用现有技术，功能目的是否达到  
　　 ●  对开发人员数量和质量的要求，并说明能否满足  
　　 ●  在规定的期限内，开发能否完成  
5  所建议系统经济可行性分析  
5.1  支出  
5.2  效益  
5.3  收益 / 投资比  
5.4  投资回收周期  
5.5  敏感性分析：指一些关键性因素，如：  
　　 ●  系统生存周期长短  
　　 ●  系统工作负荷量  
　　 ●  处理速度要求  
　　 ●  设备和软件配置变化对支出和效益的影响等的分析  
6  社会因素可行性分析  
6.1  法律因素：如  
　　 ●  合同责任  
　　 ●  侵犯专利权  
　　 ●  侵犯版权  
6.2  用户使用可行性：如  
　　 ●  用户单位的行政管理  
　　 ●  工作制度  
　　 ●  人员素质等能否满足要求  
7  其他可供选择的方案  
　　逐个阐明其它可供选择的方案，并重点说明未被推荐的理由。  
8  结论意见  
　　 ●  可着手组织开发  
　　 ●  需等待若干条件具备后才能开发  
　　 ●  需对开发目标进行某些修改  
　　 ●  不能进行或不必进行  
　　 ●  其它

 

 

                          软件需求说明书

1  引言  
1.1  编写目的：阐明编写需求说明书的目的，指明读者对象。  
1.2  项目背景：应包括  
　　 ●  项目的委托单位、开心单位和主管部门；  
　　 ●  该软件系统与其他系统的关系。  
1.3  定义：列出文档中所用到的专门术语的定义和缩写词的愿文。  
1.4  参考资料：可包括  
　　 ●  项目经核准的计划任务书、合同或上级机关的批文  
　　 ●  文档所引用的资料、规范等  
　　 ●  列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源  
2  任务概述  
2.1  目标  
2.2  运行环境  
2.3  条件与限制  
3  数据描述  
3.1  表态数据  
3.2  动态数据：包括输入数据和输出数据。  
3.3  数据库描述：给出使用数据库的名称和类型。  
3.4  数据词典  
3.5  数据采集  
4  功能需求  
4.1 功能划分  
4.2 功能描述  
5  性能需求  
5.1  数据精确度  
5.2  时间特性：如响应时间、更新处理时间、数据转换与传输时间、运行时间等。  
5.3  适应性：在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。  
6  运行需求  
6.1  用户界面：如屏幕格式、报表格式、菜单格式、输入输出时间等。  
6.2  硬件接口  
6.3  软件接口  
6.4  故障处理  
7  其他需求  
　　如可使用性、安全保密、可维护性、可移植性等。

 

                         项目开发总结报告

1 引言 
1.1 编写目的：阐明编写总结报告的目的并指明读者对象。 
1.2 项目背景：说明项目的来源、委托单位、开发单位及主管部门。 
1.3 定义：列出报告中所用到的专门术语的定义和缩写词的原意。 
1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；测试计划；测试分析报告；本报告引用的其他资料、采用的开发标准或开发规范。 
2 开发结果 
2.1 产品：可包括列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；产品文档名称等。 
2.2 主要功能及性能 
2.3 所用工时：按人员的不同层次分别计时。 
2.4 所用机时：按所用计算机机型分别计时。 
2.5 进度：给出计划进度与实际进度的对比。 
2.6 费用 
3 评价 
3.1 生产率评价：如平均每人每月生产的源程序行数、文档的字数等。 
3.2 技术方案评价 
3.3 产品质量评价 
4 经验与教训

 

                              测试分析报告

1 引言 
1.1 编写目的：阐明编写测试分析报告的目的并指明读者对象。 
1.2 项目背景：说明项目的来源、委托单位及主管部门。 
1.3定义：列出测试分析报告中所用到的专门术语的定义和缩写词的原意。 
1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；测试计划；测试分析报告所引用的其他资料、采用的软件工程标准或工程规范。 
2 测试计划招待情况 
2.1 机构和人员：给出测试机构名称、负责人和参与测试人员名单。 
2.2 测试结果：按顺序给出每一测试项目的：实测结果数据；与预期结果数据的偏差；该项测试表明的事实；该项测试发现的问题。 
3 软件需求测试结论 
　　按顺序给出每一项需求测试的结论。包括：证实的软件能力；局限性（即项需求未得到充分测试的情况及原因。
4 评价 
4.1 软件能力：经过测试所表明的软件能力。 
4.2 缺陷和限制：说明测试所揭露的软件缺陷和不足，以及可能给软件运行带来的影响。 
4.3 建议：提出为弥补上述缺陷的建议。 
4.4 测试结论：说明能否通过。

 

项目概要设计说明书

1 引言 
1.1 写目的：阐明编写概要设计说明书的目的，指明读者对象。 
1.2 项目背景：应包括 
　　● 项目的委托单位、开发单位和主管部门 
　　● 该软件系统与其他系统的关系。 
1.3 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。 
1.4 参考资料： 
　　● 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源 
　　●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册 
　　● 文档所引用的资料、采用的标准或规范。 
2 任务概述 
2.1 目标 
2.2 需求概述 
2.3 条件与限制 
3 总体设计 
3.2 总体结构和模块外部设计 
3.3 功能分配：表明各项功能与程序结构的关系。 
4 接口设计 
4.1 外部接口：包括用户界面、软件接口与硬件接口。 
4.2 内部接口：模块之间的接口。 
5 数据结构设计 
6 逻辑结构设计 
　　所有文档的统一封面格式如下页所示。 
7 物理结构设计 
8 数据结构与程序的关系 
9 运行设计 
9.1 运行模块的组合 
9.2 运行控制 
9.3 运行时间 
10 出错处理设计 
10.1 出错输出信息 
10.2 出错处理对策：如设置后备、性能降级、恢复及再启动等。 
11 安全保密设计 
12 维护设计 
　　说明为方便维护工作的设施，如维护模块等。 

 

                                软件详细设计说明书

1 引言 
1.1 编写目的：阐明编写详细设计说明书的目的，指明读者对象。 
1.2 项目背景：应包括项目的来源和主管部门等。 
1.3 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。 
1.4 参考资料： 
　　● 列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源 
　　●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；概要设计说明书；测试计划（初稿）；用户操作手册 
　　● 文档所引用的资料、软件开发的标准或规范。 
2 总体设计 
2.1 需求概述 
2.2 软件结构：如给出软件系统的结构图。 
3 程序描述 
3.1 逐个模块给出以下说明： 
　　● 功能 
　　● 性能 
　　● 输入项目 
　　● 输出项目 
3.2 算法：模块所选用的算法。 
3.3 程序逻辑：详细描述模块实现的算法，可采用：标准流程图；PDL语言；N-S图；判定表等描述算法的图表。 
3.4 接口 
　　● 存储分配 
　　● 限制条件 
3.5测试要点：给出测试模块的主要测试要求。