计算机软件开发文档编写指南.docx

《计算机软件开发文档编写指南.docx》由会员分享，可在线阅读，更多相关《计算机软件开发文档编写指南.docx（57页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。

1、一、项目开发计划1引言11.1编写目11.2项目背景11.3定义21.4参考资料22项目概述22.1工作内容22.2条件和限制22.3产品22.4运行环境22.5服务32.6验收标准33实施计划33.1任务分解33.2进度33.3预算33.4关键问题34人员组织及分工35交付期限36专题计划要点31引言1.1编写目【阐明编写开发计划目，指明读者对象。】1.2项目背景【可包括： a. 项目委托单位、开发单位和主管部门；b. 该软件系统和其他系统关系。】1.3定义【列出本档中用到专门术语定义和缩写词原文。】1.4参考资料【可包括： a. 项目经核准计划任务书、合同或上级机关批文；b. 文档所引用资

2、料、规范等；列出这些资料作者、标题、编号、发表日期、出版单位或资料来源。】2项目概述2.1工作内容【简要说明项目各项主要工作，介绍所开发软件功能、性能等。若不编写可行性研究报告，则应在本节给出较详细介绍。】2.2条件和限制【阐明为完成项目应具备条件、开发单位已具备条件以及尚需创造条件。必要时还应说明用户及分合同承包者承担工作、完成期限及其他条件和限制。】2.3产品2.3.1程序【列出应交付程序名称、使用语言及存储形式。】2.3.2文档【列出应交付文档。】2.4运行环境【应包括硬件环境、软件环境。】2.5服务【阐明开发单位可向用户提供服务。如人员培训、安装、保修、维护和其他运行支持。】2.6验收

3、标准3实施计划3.1任务分解【任务划分及各项任务负责人。】3.2进度【按阶段完成项目，用图表说明开始时间、完成时间。】3.3预算3.4关键问题【说明可能影响项目关键问题，如设备条件、技术焦点或其他风险因素，并说明对策。】4人员组织及分工5交付期限6专题计划要点【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。】二、需求规格说明书1引言11.1编写目11.2项目背景21.3定义21.4参考资料22任务概述22.1目标22.2运行环境22.3条件和限制23数据描述33.1静态数据33.2动态数据33.3数据库介绍33.4数据词典33.5数据采集34功能需求34.1功能划分34

4、.2功能描述35性能需求35.1数据精确度35.2时间特性35.3适应性36运行需求36.1用户界面36.2硬件接口36.3软件接口36.4故障处理37其它需求31引言1.1编写目【阐明编写需求说明书目，指明读者对象。】为明确软件需求、安排项目规划和进度、组织软件开发和测试，撰写本文档。本文档供项目经理、设计人员、开发人员参考。1.2项目背景c. 项目委托单位、开发单位和主管部门d. 该软件系统和其他1.3定义【列出文当中所用到专门术语定义和缩写词原文。】1.4参考资料c. 项目经核准计划任务书、合同或上级机关批文d. 项目开发计划e. 文档所引用资料、标准和规范。列出这些资料作者、标题、编号

5、、发表日期、出版单位或资料来源2任务概述2.1目标2.2运行环境操作系统：Microsoft Windows 2000 Advanced Server支持环境：IIS 5.0数 据 库：Microsoft SQL Server 20002.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运行需求6.1用户界面【如屏幕格式、报表格式、菜单格式、输入输出时间等。】6.2硬件接口6.3软件接口6.4故障处理7其它需求【如可使用性、安全保密、可维护性、可移植性等。】三、概要设计说明书1引言21.1编写目21.2项目背景21.3定义21.4参考资料22任务概述32.1目标32.2运行环境32.3需求概述32.4条件和限制33总体设计33.1处理流程33.2总体结构和模块外部设计33.3功能分配34接口设计34.1外部接口34.2内部接口35数据结构设计35.1逻辑结构设计35.2物理结构设计35.3数据结构和程序关系36运行设计36.1运行模块组合36.2运

7、行控制36.3运行时间37出错处理设计37.1出错输出信息37.2出错处理对策38.安全保密设计39.维护设计31引言1.1编写目【阐明编写概要设计说明书目，指明读者对象。】1.2项目背景【应包括： e. 项目委托单位、开发单位和主管部门；f. 该软件系统和其他系统关系。】1.3定义【列出本文档中所用到专门术语定义和缩写词原文。】1.4参考资料【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括： f. 项目经核准计划任务书、合同或上级机关批文；g. 项目开发计划；h. 需求规格说明书；i. 测试计划（初稿）；j. 用户操作手册（初稿）；k. 文档所引用资料、采用标准或规范。】

8、2任务概述2.1目标2.2运行环境2.3需求概述2.4条件和限制3总体设计3.1处理流程3.2总体结构和模块外部设计3.3功能分配【表明各项功能和程序结构关系。】4接口设计 4.1外部接口【包括用户界面、软件接口和硬件接口。】4.2内部接口【模块之间接口。】5数据结构设计5.1逻辑结构设计5.2物理结构设计5.3数据结构和程序关系6运行设计6.1运行模块组合6.2运行控制6.3运行时间7出错处理设计7.1出错输出信息7.2出错处理对策【如设置后备、性能降级、恢复及再启动等。】8.安全保密设计9.维护设计【说明为方便维护工作设施，如维护模块等。】四、详细设计说明书1引言11.1编写目11.2项目

9、背景11.3定义21.4参考资料22总体设计22.1需求概述22.2软件结构23程序描述23.1功能33.2性能33.3输入项目33.4输出项目33.5算法33.6程序逻辑33.7接口33.8存储分配33.9限制条件33.10测试要点31引言1.1编写目【阐明编写详细设计说明书目，指明读者对象。】1.2项目背景【应包括项目来源和主管部门等。】1.3定义【列出文档中所用到专门术语定义和缩写词原文。】1.4参考资料【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括： l. 项目计划任务书、合同或批文；m. 项目开发计划；n. 需求规格说明书；o. 概要设计说明书；p. 测试计划（

10、初稿）；q. 用户操作手册（初稿）；r. 文档中所引用其他资料、软件开发标准或规范。】2总体设计2.1需求概述2.2软件结构【如给出软件系统结构图。】3程序描述【逐个模块给出以下说明：】3.1功能3.2性能3.3输入项目3.4输出项目3.5算法【模块所选用算法。】3.6程序逻辑【详细描述模块实现算法，可采用：a. 标准流程图；b. PDL语言；c. NS图；d. PAD；e. 判定表等描述算法图表。】3.7接口3.8存储分配3.9限制条件3.10测试要点【给出测试模块主要测试要求。】五、用户操作手册1引言11.1编写目11.2项目背景21.3定义21.4参考资料22软件概述22.1目标22.2

11、功能22.3性能23运行环境23.1硬件23.2支持软件34.使用说明34.1安装和初始化34.2输入34.3输出34.4出错和恢复34.5求助查询35.运行说明35.1运行表35.2运行步骤36.非常规过程37.操作命令一览表38.程序文件（或命令文件）和数据文件一览表39.用户操作举例31引言1.1编写目【阐明编写手册目，指明读者对象。】1.2项目背景【应包括项目来源、委托单位、开发单位和主管部门。】1.3定义【列出手册中所用到专门术语定义和缩写词原文。】1.4参考资料【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括： s. 项目计划任务书、合同或批文；t. 项目开发计

12、划；u. 需求规格说明书；v. 概要设计说明书；w. 详细设计说明书；x. 测试计划；y. 手册中引用其他资料、采用软件工程标准或软件工程规范。】2软件概述2.1目标2.2功能2.3性能a. 数据精确度【包括输入、输出及处理数据精度。】b. 时间特性【如响应时间、处理时间、数据传输时间等。】c. 灵活性【在操作方式、运行环境需做某些变更时软件适应能力。】3运行环境3.1硬件【列出软件系统运行时所需硬件最小配置，如a. 计算机型号、主存容量；b. 外存储器、媒体、记录格式、设备型号及数量；c. 输入、输出设备；d. 数据传输设备及数据转换设备型号及数量。】3.2支持软件【如：a. 操作系统名称及

13、版本号；b. 语言编译系统或汇编系统名称及版本号；c. 数据库管理系统名称及版本号；d. 其他必要支持软件。】4.使用说明4.1安装和初始化【给出程序存储形式、操作命令、反馈信息及其含意、表明安装完成测试实例以及安装所需软件工具等。】4.2输入【给出输入数据或参数要求。】4.2.1数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。】4.2.2数据格式【如：a. 长度；b. 格式基准；c. 标号；d. 顺序；e. 分隔符；f. 词汇表；g. 省略和重复；h. 控制。】4.2.3输入举例4.3输出【给出每项输出数据说明。】4.3.1数据背景【说明输出数据去向、使用频度、存放媒体及质量管

14、理等。】4.3.2数据格式【详细阐明每一输出数据格式，如：首部、主体和尾部具体形式。】4.3.3举例4.4出错和恢复【给出：a. 出错信息及其含意；b. 用户应采取措施，如修改、恢复、再启动。】4.5求助查询【说明如何操作。】5.运行说明5.1运行表【列出每种可能运行情况，说明其运行目。】5.2运行步骤【按顺序说明每种运行步骤，应包括：】5.2.1运行控制5.2.2操作信息a. 运行目；b. 操作要求；c. 启动方法；d. 预计运行时间；e. 操作命令格式及说明；f. 其他事项。5.2.3输入/输出文件【给出建立或更新文件有关信息，如：】a. 文件名称及编号；b. 记录媒体；c. 存留目录；d

15、. 文件支配【说明确定保留文件或废弃文件准则，分发文件对象，占用硬件优先级及保密控制等。】5.2.4启动或恢复过程6.非常规过程【提供应急或非常规操作必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知操作和注意事项。】7.操作命令一览表【按字母顺序逐个列出全部操作命令格式、功能及参数说明。】8.程序文件（或命令文件）和数据文件一览表【按文件名字母顺序或按功能和模块分类顺序逐个列出文件名称、标识符及说明。】9.用户操作举例六、测试计划1引言11.1编写目11.2项目背景21.3定义21.4参考资料22任务概述22.1目标22.2运行环境22.3需求概述22.4条件和限制23计

16、划33.1测试方案33.2测试项目33.3测试准备33.4测试机构及人员34测试项目说明34.1测试项目名称及测试内容34.2测试用例34.3进度34.4条件34.5测试资料35评价35.1范围35.2准则31引言1.1编写目【阐明编写测试计划目，指明读者对象。】1.2项目背景【说明项目来源、委托单位及主管部门。】1.3定义【列出测试计划中所用到专门术语定义和缩写词原意。】1.4参考资料【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括： z. 项目计划任务书、合同或批文；aa. 项目开发计划；bb. 需求规格说明书；cc. 概要设计说明书；dd. 详细设计说明书；ee. 用

17、户操作手册；ff. 本测试计划中引用其他资料、采用软件开发标准或规范。】2任务概述2.1目标2.2运行环境2.3需求概述2.4条件和限制3计划3.1测试方案【说明确定测试方法和选取测试用例原则。】3.2测试项目【列出组装测试和确认测试中每一项测试内容、名称、目和进度。】3.3测试准备3.4测试机构及人员【测试机构名称、负责人和职责。】4测试项目说明【按顺序逐个对测试项目做出说明：】4.1测试项目名称及测试内容4.2测试用例4.2.1输入【输入数据和输入命令。】4.2.2输出【预期输出数据。】4.2.3步骤及操作4.2.4允许偏差【给出实测结果和预期结果之间允许偏差范围。】4.3进度4.4条件【

18、给出测试对资源特殊要求，如设备、软件、人员等。】4.5测试资料【说明测试所需资料。】5评价5.1范围【说明所完成各项测试说明问题范围及其局限性。】5.2准则【说明评价测试结果准则。】七、测试分析报告1引言11.1编写目11.2项目背景11.3定义11.4参考资料22测试计划执行情况22.1测试项目22.2测试机构和人员22.3测试结果23软件需求测试结论24评价34.1软件能力34.2缺陷和限制34.3建议34.4测试结论31引言1.1编写目【阐明编写测试分析报告目，指明读者对象。】1.2项目背景【说明项目来源、委托单位及主管部门。】1.3定义【列出测试分析报告中所用到专门术语定义和缩写词原文

19、。】1.4参考资料【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括： gg. 项目计划任务书、合同或批文；hh. 项目开发计划；ii. 需求规格说明书；jj. 概要设计说明书；kk. 详细设计说明书；ll. 用户操作手册；mm. 测试计划；nn. 测试分析报告所引用其他资料、采用软件工程标准或软件工作规范。】2测试计划执行情况 2.1测试项目【列出每一测试项目名称、内容和目。】2.2测试机构和人员【给出测试机构名称、负责人和参和测试人员名单。】2.3测试结果【按顺序给出每一测试项目：a. 实测结果数据；b. 和预期结果数据偏差；c. 该项测试表明事实；d. 该项测试发现问题

20、。】3软件需求测试结论【按顺序给出每一项需求测试结论。包括：a. 证实软件能力； b. 局限性（即项需求未得到充分测试情况及原因）。】4评价4.1软件能力【经过测试所表明软件能力。】4.2缺陷和限制【说明测试所揭露软件缺陷和不足，以及可能给软件运行带来影响。】4.3建议【提出为弥补上述缺陷建议。】4.4测试结论【说明能否通过。】八、开发进度月报1报告时间及所处开发阶段12工程进度12.1本月内主要活动12.2实际进展和计划比较13所用工时14所用机时25经费支出26工作遇到问题及采取对策27本月完成成果28下月工作计划29特殊问题21报告时间及所处开发阶段2工程进度2.1本月内主要活动2.2实

21、际进展和计划比较3所用工时【按不同层次人员分别计时。】4所用机时【按所用计算机型分别计时。】5经费支出【分类列出本月经费支出项目，给出支出总额，并和计划比较。】6工作遇到问题及采取对策7本月完成成果8下月工作计划9特殊问题九、项目开发总结报告1引言11.1编写目11.2项目背景11.3定义11.4参考资料22开发结果22.1产品22.2主要功能及性能22.3所用工时22.4所用机时22.5进度22.6费用33评价33.1生产率评价33.2技术方案评价33.3产品质量评价34经验和教训31引言1.1编写目【阐明编写总结报告目，指明读者对象。】1.2项目背景【说明项目来源、委托单位、开发单位及主管

22、部门。】1.3定义【列出报告用到专门术语定义和缩写词原文。】1.4参考资料【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括： oo. 项目经核准计划任务书、合同或上级机关批文；pp. 项目开发计划；qq. 需求规格说明书；rr. 概要设计说明书；ss. 详细设计说明书； tt. 用户操作手册；uu. 测试计划；vv. 测试分析报告；ww. 本报告引用其他资料、采用开发标准或开发规范。】2开发结果2.1产品【可包括：a. 列出各部分程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；b. 产品文档名称等。】2.2主要功能及性能2.3所用工时【按人员不同

23、层次分别计时。】2.4所用机时【按所用计算机机型分别计时。】2.5进度【给出计划进度和实际进度对比。】2.6费用3评价3.1生产率评价【如平均每人每月生产源程序行数、文档字数等。】3.2技术方案评价3.3产品质量评价4经验和教训十、程序维护手册1引言11.1编写目11.2开发单位11.3定义21.4参考资料22系统说明22.1系统用途22.2安全保密22.3总体说明22.4程序说明23操作环境33.1设备33.2支持软件33.3数据库34维护过程34.1约定34.2验证过程34.3出错及纠正方法34.4专门维护过程34.5专用维护程序34.6程序清单和流程图31引言1.1编写目【阐明编写手册目

24、，指明读者对象。】1.2开发单位【说明项目提出者、开发者、用户和使用场所。】1.3定义【列出报告中所用到专门术语定义和缩写词原文。】1.4参考资料【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，以及保密级别，可包括： xx. 用户操作手册；yy. 和本项目有关其他文档。】2系统说明2.1系统用途【说明系统具备功能，输入和输出。】2.2安全保密【说明系统安全保密方面考虑。】2.3总体说明【说明系统总体功能，对系统、子系统和作业做出综合性介绍，并用图表方式给出系统主要部分内部关系。】2.4程序说明【说明系统中每一程序、分程序细节和特性。】2.4.1程序1说明2.4.1.1功能【说明程

25、序功能。】2.4.1.2方法【说明实现方法。】2.4.1.3输入【说明程序输入、媒体、运行数据记录、运行开始时使用输入数据类型和存放单元、和程序初始化有关入口要求。】2.4.1.4处理【处理特点和目，如：a. 用图表说明程序中运行逻辑流程；b. 程序主要转移条件；c. 对程序约束条件；d. 程序结束时出口要求； e. 和下一个程序通信和联结（运行、控制）；f. 由该程序产生并供处理程序段使用输出数据类型和存放单元；g. 程序运行所用存储量、类型及存储位置等。】2.4.1.5输出【程序输出。】2.4.1.6接口【本程序和本系统其他部分接口。】2.4.1.7表格【说明程序内部各种表、项细节和特性。

26、对每张表说明至少包括：a. 表标识符；b. 使用目；c. 使用此表其他程序；d. 逻辑划分，如块或部，不包括表项；e. 表基本结构；f. 设计安排，包括表控制信息。表目结构细节、使用中特有性质及各表项标识、位置、用途、类型、编码表示。】2.4.1.8特有运行性质【说明在用户操作手册中没有提到运行性质。】2.4.2程序2说明【和程序1说明相同。以后其他各程序说明相同。】3操作环境3.1设备【逐项说明系统设备配置及其特性。】3.2支持软件【列出系统使用支持软件，包括它们名称和版本号。】3.3数据库【说明每个数据库性质和内容，包括安全考虑。】3.3.1总体特征【如：a. 标识符；b. 使用这些数据库

27、程序；c. 静态数据；d. 动态数据；e. 数据库存储媒体；f. 程序使用数据库限制。】3.3.2结构及详细说明3.3.2.1说明该数据库结构，包括其中记录和项；3.3.2.2说明记录组成，包括首部或控制段、记录体；3.3.2.3说明每个记录结构字段，包括：标记或标号、字段字符长度和位数、该字段充许值范围。3.3.2.4扩充：说明为记录追加字段规定；4维护过程4.1约定【列出该软件系统设计中所使用全部规则和约定，包括：a. 程序、分程序、记录、字段和存储区标识或标号助记符使用规则；b. 图表处理标准、卡片连接顺序、语句和记号中使用缩写、出现在图表中符号名；c. 使用软件技术标准；d. 标准化数

28、据元素及其特征。】4.2验证过程【说明一个程序段修改后，对其进行验证要求和过程（包括测试程序和数据）及程序周期性验证过程。】4.3出错及纠正方法【列出出错状态及其纠正方法。】4.4专门维护过程【说明文档其他地方没有提到专门维护过程，如：a. 维护该软件系统输入输出部分（如数据库）要求、过程和验证方法；b. 运行程序库维护系统所必需要求、过程和验证方法；c. 对闰年、世纪变更所需临时性修改等。】4.5专用维护程序【列出维护软件系统使用后备技术和专用程序（如文件恢复程序、淘汰过时文件程序等）目录，并加以说明，内容包括：a. 维护作业输入输出要求； b. 输入详细过程及在硬设备上建立、运行并完成维护

29、作业操作步骤。】4.6程序清单和流程图【引用资料或提供附录给出程序清单和流程图。】十一、软件问题报告1登记号12登记日期13问题发现日期14活动25状态26报告人27问题属于什么方面28模块/子系统29修订版本号210磁带311数据库312文件号313测试用例314硬件315问题描述/影响316附注31登记号【由软件配置管理部门为该报告规定一个唯一、顺序编号。】2登记日期【软件配置管理部门登记该报告日期。】3问题发现日期【发现该问题日期和时间。】4活动【在哪个阶段发现问题，分为单元测试、组装测试、确认测试和运行维护。】5状态【在软件配置记录中维护动态指示，状态表示有：a. 正在复查“软件问题报

30、告”，以确定将采取什么行动；b. 软件问题报告”已由指定人去进行处理；c. 修改已完成，并经过测试，正准备交给主程序库；d. 主程序库已经更新，主程序库修改重新测试尚未完成；e. 做了重新测试，问题再现；f. 做了重新测试，所做修改已无故障，“软件问题报告”被关闭；g. 留待以后关闭。】6报告人【填写“软件问题报告”人员姓名、地址、电话。】7问题属于什么方面【区分是程序问题，还是模块问题，或是数据库问题，文件问题。也可能是它们某种组合。】8模块/子系统【出现模块名。如果不知是哪个模块，可标出子系统名，尽量给出细节。】9修订版本号【出现问题模块版本。】10磁带【包含有问题模块主程序库磁带标识符。

31、】11数据库【当发现问题时所使用数据库标识符。】12文件号【有错误文件编号。】13测试用例【发现错误时所使用测试用例标识符。】14硬件【发现错误时所使用计算机系统标识。】15问题描述/影响【问题症兆详细描述。如果可能，是写明实际问题所在。也要给出该问题对将来测试、接口软件和文件等影响。】16附注【记载补充信息。】十二、软件修改报告1登记号12登记日期13时间24报告人25子系统名26模块名27“软件修改报告”编号28修改29修改描述210批准人311语句类型312程序名313老修订版314新修订版315数据库316数据库修改报告317文件318文件更新319修改是否已测试320“软件问题报告”

32、是否给出问题准确描述321问题注释322问题源323资源31登记号【由软件配置管理部门为该报告规定编号。】2登记日期【软件配置管理部门登记“软件修改报告”日期。】3时间【准备好“软件修改报告”日期。】4报告人【填写该报告作者。】5子系统名【受修改影响子系统名。】6模块名【被修改模块名。】7“软件修改报告”编号 【被“软件修改报告”处理或部分处理“软件问题报告”编号。如果某“软件问题报告”问题只是部分被处理，则在编号后附以p，如1234p。】8修改【包括程序修改、文件更新、数据库修改或它们组合。】9修改描述【修改详细描述。如果是文件更新或数据库修改，还要列出文件更新通知或数据库修改申请标识符。】

33、10批准人【批准人签字，正式批准进行修改。】11语句类型【程序修改中涉及到语句类型，包括：输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类（如数据传送、存取语句类）。】12程序名【被修改程序、文件或数据库名字。】13老修订版【当前版本/修订本标识。】14新修订版【修改后版本/修订本标识。】15数据库【如果申请数据库修改，则给出数据库标识符。】16数据库修改报告【数据库修改申请号。】17文件【如果要求对文件进行修改，则给出文件名字。】18文件更新【文件更新通知单编号。】19修改是否已测试【指出已对修改做了哪些测试，如单元、子系统、组装、确认和运行测试等，并注明测试成功和否。】20“软

34、件问题报告”是否给出问题准确描述【回答是或否。】21问题注释【准确地叙述要维护问题。】22问题源【指明问题来自于哪里，如软件需求说明书、设计说明书、数据库、源程序等。】23资源【完成修改所需资源估计，即总人时数和计算机时间开销。】 可行性研究报告：说明该软件开发项目实现在技术上、经 济上和社会因素上可行性，评述为了合理地达到开发目标可供 选择各种可能实施方案，说明并论证所选定实施方案理 由。 项目开发计划：为软件项目实施方案制定出具体计划，应 该包括各部分工作负责人员、开发进度、开发经费预算、所 需硬件及软件资源等。项目开发计划应提供给管理部门，并作 为开发阶段评审参考。 软件需求说明书：也称

35、软件规格说明书，其中对所开发软 件功能、性能、用户界面及运行环境等作出详细说明。它是用 户和开发人员双方对软件需求取得共同理解基础上达成协议， 也是实施开发工作基础。 数据要求说明书：该说明书应给出数据逻辑描述和数据采 集各项要求，为生成和维护 系统数据文卷作好准备。 概要设计说明书：该说 明书是概要设计阶段工作 成果，它应说明功能分配、模 块划分、程序总体结构、输 入输出以及接口设计、运行设 计、数据结构设计和出错处理 设计等，为详细设计奠定基 础。 详细设计说明书：着重 描述每一模块是怎样实现， 包括实现算法、逻辑流程等。 用户手册：本手册详细 描述软件功能、性能和用户 界面，使用户了解如

36、何使用该软件。文档用户文档用户手册操作手册维护修改建议软件需求（规格）说明书开发文档软件需求（规格）说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划管理文档项目开发计划测试计划测试报告开发进度月报开发总结报告 图 三种文档 操作手册：本手册为操作人员提供该软件各种运行情况 有关知识，特别是操作方法具体细节。 测试计划：为做好组装测试和确认测试，需为如何组织测试 制定实施计划。计划应包括测试内容、进度、条件、人员、测试用 例选取原则、测试结果允许偏差范围等。 测试分析报告：测试工作完成以后，应提交测试计划执行 情况说明。对测试结果加以分析，并提出测试结论意见。 开发进度

37、月报：该月报系软件人员按月向管理部门提交 项目进展情况报告。报告应包括进度计划和实际执行情况比较、 阶段成果、遇到问题和解决办法以及下个月打算等。 项目开发总结报告：软件项目开发完成以后，应和项目实 施计划对照，总结实际执行情况，如进度、成果、资源利用、成本 和投入人力。此外还需对开发工作作出评价，总结出经验和教 训。 维护修改建议，软件产品投入运行以后，发现了需对其进 行修正、更改等问题，应将存在问题、修改考虑以及修改影 响估计作详细描述，写成维护修改建议，提交审批。 以上这些文档是在软件生存期中，随着各阶段工作开展适 时编制。其中有仅反映一个阶段工作，有则需跨越多个阶 段。表5给出了各个文

38、档应在软件生存期中哪个阶段编写。这 些文档最终要向软件管理部门，或是向用户回答以下问题： 表9.2 软件生存期各阶段编制文档 阶段文档可行性药酒和计划需求分析设计代码编写测试运行和维护可行性研究报告项目开发计划软件需求说明数据要求说明概要设计说明星系设计说明测试计划用户手册操作手册测试分析报告开发进度月报项目开发总结维护修改建议 哪些需求要被满足，即回答“做什么?” 所开发软件在什么环境中实现以及所需信息从哪里来， 即回答“从何处?” 某些开发工作时间如何安排，即回答“何时干?” 某些开发(或维护)工作打算由“谁来干?” 某些需求是怎么实现? 为什么要进行那些软件开发或维护修改工作? 上述十三个文档都在一定程度上回答了这六个方面问题。这可从表中看到。表 文档所回答问题所提问题文档什么 何处 何时 谁 如何 为何 可行性研究报告 项目开发计划 软件需求说明 数据要求说明 概要设计说明 详细设计说明 测试计划 用户手册 操作手册 测试分析报告 开发进度月报 项目开发总结 维护修改建议 至此，我们对文档作用有了进一步理解。每一个文档任 务也是明确，任何一个文档都此是多余。