发信人: bllsbgw(SPARK)
整理人: soaringbird(2002-03-05 15:20:58), 站内信件
|
第二篇各种文件的内容要求
本篇将对引言中提到的十四种文件提供内容要求，作为文件编制的技术标准。
7 可行性研究报告
可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行 性；评述为了合理地达到开发目标而可能选择的各种方案；说明并论证所选定的方案。
可行性研究报告的编写内容要求如下：
7．1引言
7．1．1编写目的
7．1．2背景
7．1．3定义
7．1．4参考资料 7
7．2可行性研究的前提
7．2．1要求
7．2．2目标
7·2．3条件、假定和限制
7．2．4进行可行性研究的方法
7．2．5评价尺度
7·3对现有系统的分析
7．3．1数据流程和处理流程
7．3．2工作负荷
7．3.3费用开支
7．3.4人员
7．3.5设备
7．3.6局限性
7．4所建议的系统
7．4．1对所建议系统的说明
7．4．2数据流程和处理流程
7．4．3改进之处
7．4．4影响
7．4．4．1对设备的影响
7．4．4．2对软件的影响
7．4．4．3对用户单位机构的影响
7．4．4．4对系统运行的影响
7．4．4．5对开发的影响
7．4，4．6对地点和设施的影响
7．4．4．7对经费开支的影响
7．4．5局限性
7．4．6技术条件方面的可行性
7．5可选择的其他系统方案
7．5．1可选择的系统方案1
7．5．2可选择的系统方案2
...
7．6投资及收益分析
7．6．1支出
7．6．1．1基本建设投资
7．6．1．2其他一次性支出
7.6．1，3非一次性支出
7．6．2收益
7．6，2．1一次性收益
7．6．2．2非一次性收益
7.6.2.3不可定量的收益
7．6．3收益／投资比
7．6．4投资回收周期
7．6.5敏感性分析
7．7社会条件方面的可行性
7．7．1法律方面的可行性
7．7．2使用方面的可行性
7．8结论
8 项目开发计划
编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、 所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开 发工作。编制内容要求如下：
8.1引言
8．1．1编写目的
8.1．2背景
8．1．3定义
8．1．4参考资料
8．2项目概述
8．2．11作内容
8．2．2主要参加人员
8．2．3产品及成果
8．2．3．1程序
8．2．3.2文件
8．2．3.3服务
8．2．3.4非移交产品
8．2．4验收标准
8·2． 5完成项目的最迟期限
8.2·6本计划的审查者与批准者
8．3实施总计划
8．3.1工作任务的分解
8．3.2接口人员
8．3.3进度
8．3.4预算
8．3.5关键问题
8．4支持条件
8．4．1计算机系统支持
8·4·2需要用户承担的工作
8·4·3需由外单位提供的条件
8．5专题计划要点
9 软件需求说明书
软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解， 使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下：
9．1引言
9．1．1编写目的
9．1．2背景
9．1.3定义
9．1．4参考资料
9.2任务概述
9．2．1目标
9．2．2、用户的特点
9．2．3假定与约束
9．3需求规定
9．3．1对功能的规定
9．3．2对性能的规定
9.3.2．1精度
9.3．2．2时间特性耍求
9．3.2．3灵活性
9．3．3输入输出要求
9．3.4数据管理能力要求
9．3.5故障处理要求
9．3.6其他专门要求
9．4运行环境规定
9．4．1设备
9．4．2支持软件
9．4．3接口
9．4．4控制
10 数据要求说明书
数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下：
10．1引言
10．1．1编写目的
10．1．2背景
10．1．3定义
10．1．4参考资料
10．2数据的逻辑描述
10． 2． 1静态数据
10．2．2动态输入数据
10．2．3动态输出数据
10．2．4内部生成数据
10．2．5数据约定
10．3数据的采集
10.3.1要求和范围
10．3．2输入的承担者
10．3 .3处理
10．3. 4影响。
11 概要设计说明书
概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序 系统的设计考虑，包括程序系统的基本处。流程、程序系统的组织结构、模块划分、功能分配、接口设计。 运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下：
11．1引言
11.1． 1编写目的
11．1．2背景
11．］．3定义
11.1．4参考资料
11·2总体设计
11·2·1需求规定
11·2．2运行环境
11．2．3基本设计概念和处理流程
11． 2． 4”结构
11．2．5功能需求与程序的关系
11． 2． 6人工处理过程
11．2．7尚未解决的问题
11．3接口设计
11．3.1用户接口
11．3.2外部接口
11．3 .3内部接口
11．4运行设计
11· 4· 1运行模块组合
11·4·2运行控制
11·4·3运行时间
11·5系统论据结构设计
11· 5· 1逻辑结构设计要点
11· 5· 2物理结构设计要点
11·5·3数据结构与程序的关系
11． 6系统出错处理设计
11· 6· 1出错信息
11·6．2补救措施
11·6 3系统维护设计
12详细设计说明书
详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序 （每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关 内容合并入概要设计说明书。对详细设计说明书的内容要求如下：
12·1引言
12·1．1编写目的
12·1．2背景
12．1．3定义
12· 1· 4参考资料
12·2程序系统的组织结构
12· 3程序1（标识符）设计说明
12· 3． 1程序描述
12·3.2功能
12·3.3性能
12·3.4输入项
12·3．5输出项
12·3．6算法
12·3·7流程逻辑
12．3.8接口
12．3. 9存储分配
12· 3.10注释设计
12·3 .11限制条件
12. 3.12测试计划．
12·3．13尚未解决的问题
12．4程序2（标识符）设计说明
...
13 数据库设计说明书
数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定。其内容要求如下：
13.1引言
13·1．1编写目的
13.1．2背景
13.1．3定义
13.1·4参考资料
13．2外部设计
13.2．1标识符和状态
13·2·2使用它的程序
13. 2． 3约定
13. 2·4专门指导
13·2·5支持软件
13. 3结构设计
13. 3·1概念结构设计
13·3·2逻辑结构设计
13·3·3物理结构设计
13. 4运用设计
13.4·1数据字典设计
13 4·2安全保密设计
14 用户手册
用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。使用户（或潜在用户）通过本手册能够了解该软件的用途，并且能够确定在什么情况下，如何使用它。具体的内容要求如下：
14.1引言
14·1．1编写目的
14·1·2背景
14·1．3定义
14·1·4参考资料
14·2用途
14·2．1功能
14· 2． 2性能
14· 2． 2． 1精度
14·2·2．2时间特性
14. 2． 2． 3灵活性
14· 2· 3安全保密
14· 3运行环境
14·3·1硬设备
14· 3. 2支持软件
14· 3· 3数据结构
14· 4使用过程
14·4·1安装与初始化
14． 4． 2输入
14·4.2·1输入数据的现实背景
14· 4· 2． 2输入格式
14· 4． 2． 3输入举例
14．4．3输出
14·4·3.1输出数据的现实背景
14· 4· 3.2输出格式
14·4·3·3输出举例
14·4·4文卷查询
14·4·5出错处理与恢复
14·4·6终端操作
15 操作手册
操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方法的细节。具体的内容要求如下：
15·1引言
15·1．1编写目的
15·1·2背景
15·1．3定义
15· 1· 4参考资料
15· 2．软件概述
15· 2· 1软件的结构
15· 2· 2程序表
15·2·3文卷表
15．3安装与初始化
15·4运行说明
15· 4． 1运行表
15．4．2运行步骤
15· 4． 3运行1（标识符）说明
15·4· 3． 1运行控制
15· 4· 3 2操作信息
15· 4·3 3输入一输出文卷
15．4．3．4输出文段
15·4·3·5输出文段的复制
15．4．3 6启动恢复过程
15·4·4运行2（标识符）说明
．．．．．．
15·5非常现过程
15·6远程操作
16 模块开发卷宗
模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。具体的内容要求如下：
16· 1标题
16．2模块开发情况表（见下表）
16·3功能说明
16·4设计说明
16·5源代码清单
16· 6测试说明
16·7复审的结论
17测试计划
这里所说的测试，主要是指整个程序系统的组装测试和确认测试。本文件的编制是为了提供一个对该软件的测试计划，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则。具体的内容要求如下：
17·1引言
17．1．1编写目的
17·1·2背景
17．1．3定义
17·1·4参考资料
17. 2计划
17·2·1软件说明
17·2·2测试内容
17．2．3测试1（标识符）
17·2·3.1进度安排
17· 2. 3. 2条件
17· 2· 3． 3测试资料
17． 2． 3 4测试培训
17．2．4测试2（标识符）
...
17·3测试设计说明
17．3．1测试l（标识符）
17· 3·1． 1控制
17． 3.1． 2输入
17．3．1．3输出
17．3．1．4过程
17．3 .2测试2（标识符）
...
17·4评价准则
17·4．1范围
17．4．2数据整理
17·4．3尺度
18 测试分析报告
测试分析报告的编写是为了把组装测试和确认测试的结果、发现及分析写成文件加以记载，具体的内容要求如下：
18．1引言
18．1．1编写目的
18．1．2背景
18．1．3定义
18．1．4参考资料
18．2测试概要
18．3测试结果及发现
18．3.1测试1（标识符）
18．3．2测试2（标识符）
...
18．4对软件功能的结论
18．4．1功能1（标识符）
18．4．1．1能力
18．4．1．2限制
18．4．2功能2（标识符）
18．5分析摘要
18．5．1能力
18．5．2缺陷和限制
18．5．3建议
18．5．4评价
18．6测试资源消耗
19 开发进度月报
开发进度月报的编制目的是及时向有关管理部门汇报项目开发的进展和情况，以便及时发现和处理开发过程中出现的问题。一般地，开发进度月报是以项目组为单位每月编写的。如果被开发的软件系 统规模比较大，整个工程项目被划分给若干个分项目组承担，开发进度月报将以分项目组为单位按月编 写。具体的内容要求如下：
19． 1标题
19．2工程进度与状态
19．2．1进度
19．2．2状态
19．3资源耗用与状态
19．3．1资源耗用
19.3.1．1工时
19 .3．1．2机时
19．3. 2状态
19．4经费支出与状态
19．4．1经费支出
19．4．1．1支持性费用
19．4．1．2设备购置费
19． 4． 2状态
19·5下个月的工作计划
19．6建议
20 项目开发总结报告
项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价。具体的内容要求如下：
20．1引言
20.1.1编写目的
20.1.2背景
20.1.3定义
20.1.4参考资料
20. 2.1产品
20.2实际开发结果
20.2.2主要功能和性能
20.2.3基本流程
20.2.4进度
20.2.5费用
20.3开发工作评价
20.3.1对生产效率的评价
20.3.2对产品质量的评价
20.3. 3对技术方法的评价
20.3. 4出错原因的分析
20.4经验与教训
|
|