计算机软件开发文档编写规范Word文件下载.docx

1、d法律和政策方面的限制；e硬件、软件、运行环境和开发环境的条件和限制；f可利用的信息和资源；g建议开发软件投入使用的最迟时间。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.4.1 对设备的影响4.4.2

2、 对现有软件的影响4.4.3 对用户的影响4.4.4 对系统运行的影响4.4.5 对开发环境的影响4.4.6 对运行环境的影响4.4.7 对经费支出的影响4.5 技术可行性评价【包括：a在限制条件下，功能目标是否能达到；b利用现有技术，功能目标能否达到；c对开发人员数量和质量的要求，并说明能否满足；d在规定的期限内，开发能否完成。5 所建议系统经济可行性分析5.1 支出 5.1.1 基建投资5.1.2 其他一次性支出 5.1.3 经常性支出5.2 效益5.2.1 一次性收益5.2.2 经常性收益5.2.3 不可定量性收益5.3 收益/投资比5.4 投资回收周期5.5 敏感性分析【敏感性分析是指

3、一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。6 社会因素可行性分析6.1 法律因素【如，合同责任、侵犯专利权、侵犯版权等问题的分析。6.2 用户使用可行性【如，用户单位的行政管理、工作制度、人员素质等能否满足要求。7 其他可行性选择的方案【逐个阐明其他可供选择的方案，并重点说明未被推荐的理由。8 结论意见【结论意见可能是：a可着手组织开发；b需待若干条件（如资金、人力、设备等）具备后才能开发；c需对开发目标进行某些修改；d不能进行或不必进行（如技术不成熟，经济上不合算等）；e其他。二. 项目开发计划1.1 编写目的【阐明编写

4、开发计划的目的，指出读者对象。1.2 项目背景【可包括：a项目的委托单位、开发单位主管部门；b该软件系统与其他系统的关系。1.3 定义【列出本档中用到的专门术语的定义和缩写词的原文。1.4 参考资料【可包括：b文档所引用的资料、规范等；列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。2 项目概述2.1 工作内容【简要说明项目的各项主要工作，介绍所开发软件的功能、性能等。若不编写可行性研究报告，则应在本节给出较详细的介绍。2.2 条件与限制【阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承包者承担的工作、完成期限及其他条件与限制。2.

5、3 产品2.3.1 程序【列出应交付的程序名称、使用的语言及存储形式。2.3.2 文档【列出应交付的文档】2.4 运行环境【应包括硬件环境、软件环境。2.5 服务【阐明开发单位可向用户提供的服务。如人员的培训、安装、保修、维护和其他运行支持。2.6 验收标准3 实施计划3.1 任务分解【任务的划分及各项任务的负责人。3.2 进度【按阶段完成的项目，用图表说明开始时间、完成时间。3.3 预算3.4 关键问题【说明可能影响项目的关键问题，如设备条件、技术难点或其他风险因素。4 人员组织及分工5 交付期限6 专题计划要点 【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。三.

6、需求规格说明书1.1 编写目的【阐明编写需求说明书的目的，指明读者对象。a项目的委托单位、开发单位和主管部门；1.3 定义【列出文档中所用到的专门术语的定义和缩写词的原文。b项目开发计划；c文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日出版单位或资料来源。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 时间特性【如响应时间、更新处理时

7、间、数据转换与传输时运行时间等。5.3 适应性【在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。6 运行需求6.1 用户界面【如屏幕格式、报表格式、菜单格式、输入输出时间等。6.2 硬件接口6.3 软件接口6.4 故障处理7 其他需求【如可使用性、安全保密、可维护性、可移植性等。四. 概要设计说明书1.1 编写的目的【阐明编写概要设计说明书的目的，指明读者对象。1.3 定义【列出本文档中所用到的专门术语的定义和缩写词的原意。c需求规格说明书；d测试计划（初稿）；e用户操作手册（初稿）；f文档所用的资料、采用的标准或规范。2 任务概述2.3 需求概述2.4 条件

8、与限制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.1 编写目的【阐明编写详细设计说明书的目的，指明读者

9、对象。1.2 项目背景【应包括项目的来源和主管部门等。1.3 定义【列出文档中所用到的专门术语的定义各缩写词的原意。a项目的计划任务书、合同或批文；d概要设计说明书；e测试计划（初稿）；f用户操作手册（初稿）；g文档所引用的其他资料、软件开发标准或规范。2 总体设计2.1 需求概述2.2 软件结构【如给出的软件系统的结构图。3 程序描述 【逐个模块给出以下的说明：3.1 功能3.2 性能3.3 输入项目3.4 输出项目3.5 算法【模块所选用的算法。3.6 程序逻辑【详细描述模块实现的算法，可采用：a标准流程图；b.PDL语言；c.N-S图；d.PAD；e判定表等描述算法的图表。3.7 接口3

10、.8 存储分配3.9 限制条件3.10 测试要点【给出测试模块的主要测试要求。六. 用户操作手册1.1 编写目的【阐明编写手册的目的，指明读者对象。1.2 项目背景【说明项目来源、委托单位、开发单位及主管部门。1.3 定义【列出手册中使用的专门术语的定义和缩写词的原意。e详细设计说明书；f测试计划；g手册中引用的其他资料、采用的软件工程标准或软件工程规范。2 软件概述2.2 功能2.3 性能2.3.1 数据精确度【包括输入、输出及处理数据的精度。2.3.2 时间特性【如响应时间、数据传输时间等。2.3.3 灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。3 运行情况3.1 硬件【列出

11、软件系统运行所需的硬件最小配置，如 a计算机型号、主存容量；b外存储器、媒体、记录格式、设备型号及数量；c输入、输出设备；d数据传输设备及数据转换设备的型号及数量。3.2 支持软件【如a操作系统名称及版本号；b语言编译系统或汇编系统的名称及版本号；c数据库管理系统的名称及版本号；d其他必要的支持软件。4 使用说明4.1 安装和初始化【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需用软件工具等。4.2 输入【给出输入数据或参数的要求。4.2.1 数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。4.2.2 数据格式【如a长度；b格式基准；c标号；d

12、顺序；e分隔符；f词汇表；g省略和重复；h控制。4.2.3 输入举例4.3 输出【给出每项输出数据的说明。4.3.1 数据背景【说明输出数据的去向、使用频度、存放媒体及质量管理等。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预

13、计运行时间；e操作命令格式及说明；f其他事项。5.2.3 输入/输出文件【给出建立或更新文件的有关信息,如:】 a文件的名称及编号；b记录媒体；c存留的目录；d文件的支配【说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等。5.2.4 启动或恢复过程6 非常规过程 【提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。7 操作命令一览表 【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。8 程序文件（或命令文件）和数据文件一览表 【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。9

14、 用户操作举例七. 测试计划1.1 编写目的【阐明编写测试计划的目的并指明读者对象。1.2 项目背景【说明项目的来源、委托单位及主管部门。1.3 定义【列出测试计划中所用到的专门术语的定义和缩写词的原意。1.4 参考资料【列出有关资料的作者、标题、编号恨表日期、出版单位或资料来源，可包括：e详细设计说书；f用户操作手册；g本测试计划中引用的其他资料、采用的软件开发标准或规范。3 计划3.1 测试方案【说明确定测试方法和选取测试用例的原则。3.2 测试项目【列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。3.3 测试准备3.4 测试机构及人员【测试机构名称、负责人和职责。】 4 测试

15、项目说明【按顺序逐个对测试项目做出说明：4.1 测试项目名称及测试内容4.2 测试用例4.2.1 输入【输入的数据和输入的命令。4.2.2 输出【预期的输出数据。4.2.3 步骤及操作4.2.4 允许偏差【给出实测结果与预期结果之间允许偏差范围。4.3 进度4.4 条件【给出项测试对资源的特殊要求，如设备、软件、人员等。4.5 测试资料【说明项测试所需的资料。5 评价5.1 范围【说明所完成的各项测试说明问题的范围及其局限性。5.2 准则【说明评价测试结果的准则。八. 测试分析报告 1.3 定义【列出测试报告中用到的专门术语的定义和缩写词的原意。g测试计划；h测试分析报告所引用的其他资料、采用

16、的软件工程标准或软件工程规范。2 测试计划执行情况2.1 测试项目【列出每一次测试项目的名称、内容和目的。2.2 测试机构和人员【给出测试机构名称、负责人和参与测试人员名单。2.3 测试结果【按顺序给出每一测试项目的：a实测结果数据；b与预期结果数据的偏差；c该项测试表明的事实；d该项测试发现的问题。3 软件需求测试结论【按顺序给出每一项需求测试的结论。包括：a证实的软件能力；b局限性（即项需求未得到充分测试的情况及原因）。4 评价4.1 软件能力【经过测试所表明的软件能力。4.2 缺陷和限制【说明测试所揭露的软件缺陷和不足，以及可能给软件运行带来的影响。4.3 建议【提出为弥补上述缺陷的建议

17、。4.4 测试结论【说明能否通过。九. 开发进度月报1 报告时间及所处的开发阶段2 工程进度2.1 本月内的主要活动2.2 实际进展与计划比较3 所用工时【按不同层次人员分别计时。4 所用机时【按所用计算机机型分别计时。5 经费支出【分类列出本月经费支出项目，给出支出总额，并与计划比较。6 工作遇到的问题及采取的对策7 本月完成的成果8 下月的工作计划9 特殊问题一十. 项目开发总结报告1.1 编写目的【阐明编写总结计划的目的并指明读者对象。1.2 项目背景【说明项目的来源、委托单位开发单位及主管部门。1.3 定义【列出报告用到的专门术语的定义和缩写词的原意。h测试分析报告；I本报告引用的其他

18、资料、采用的开发标准或开发规范。2 开发结果2.1 产品【可包括：a列出各部分和程序名称、源程序行数（包括注释行）或目标程序字节数及程序字节数及程序总计数量、存储形式；b产品文档名称等。2.2 主要功能及性能。2.3 所用工时【按人员的不同层次分别计时。2.4 所用机时【按所用计算机机型分别计时。2.5 进度【给出计划进度与实际进度的对比。2.6 费用3 评价3.1 生产率评价【如平均每人每月生产的源程序行数、文档的字数等。3.2 技术方案评价3.3 产品质量评价4 经验与教训一十一. 程序维护手册1.1 编写目的【阐明编写手册的目的并指明读者对象。1.2 开发单位【说明项目的提出者、开发者、

19、用户和使用场所。1.4 参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源以及保密级别，可包括：a用户操作手册； b与本项目有关节其他文档。2 系统说明2.1 系统用途【说明系统具备的功能，输入和输出。2.2 安全保密【说明系统安全保密方面的考虑。2.3 总体说明【说明系统的总体功能，对系统、子系统和作业做出综合性的介绍，并用图表的方式给出系统主要部分的内部关系。2.4 程序说明【说明系统中每一程序、分程序的细节和特性。2.4.1 程序说明功能2.4.1.1 功能【说明程序的功能。2.4.1.2 方法【说明实现方法。2.4.1.3 输入【说明程序的输入、媒体、运行数据记录、

20、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。2.4.1.4 处理【处理特点的目的，如：a用图一说明程序的运行和逻辑流程；b程序主要转移条件；c对程序的约束条件；d程序结束时的出口要求；e与下一程序的通信与联结（运行、控制）；f由该程序产生并供处理程序段使用的输出数据类型和存放单元。g程序运行所用存储量、类型及存储位置等。2.4.1.5 输出【程序的输出。2.4.1.6 接口【本程序与本系统其他部分的接口。2.4.1.7 表格【说明内部的各种表、项的细节和特性。对每张表的说明至少包括：a表的标识符；b使用目的；c使用此表的其他程序；d逻辑划分，如块或部，不包括表项；e表

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

22、3.3.2.1 说明该数据库的结构，包括其中的记录和项；3.3.2.2 说明记录的组成，包括首部或控制段、记录体；3.3.2.3 说明每个记录结构的字段，包括：标记或标号、字段的字符长度和位数、该字段的允许值范围。3.3.2.4 扩充：说明为记录结构的字段；4 维护过程4.1 约定【列出该软件系统设计中所使用全部规则和约定，包括：a程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则；b图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号；c使用软件技术标准； d 标准化数据元素及其特征。4.2 验证过程【说明一个程序段修改后，对其进行验证的要求和过程（包括测试程

23、序和数据）及程序周期性验证的过程。4.3 出错及纠正方法【列出出错状态及其纠正方法。4.4 专门维护过程【说明文档其他地方没有提到的专门维护过程，如a维护该软件系统的输入输出部分（如数据库）的要求、过程和验证方法；b运行程序库维护系统所必需的要求、过程和验证方法；c以闰年、世纪变更所需要的临时性修改等。4.5 专用维护程序【列出维护软件系统使用的后备技术和专用程序（如文件恢复程序、淘汰过时文件的程序等）的目录，并加以说明，内容包括：a 维护作业的输入输出要求；b输入的详细过程及在硬设备上建立、运行并完成维护作业操作步骤。4.6 程序清单和流程图【引用资料或提供附录给出程序清单和流程图。一十二.

24、 软件问题报告1 登记号【由软件配置管理部门为该报告规定一个唯一的、顺序的编号。2 登记日期【软件配置管理部门登记该报告的日期。3 问题发现日期【发现该问题的日期和时间。4 活动【在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运行维护。5 状态【在软件与配置记录中维护的动态指示，状态表示有a正在复查“软件问题报告”，以确定将采取什么行动；b“软件问题报告”已由指定的人进行处理；c修改已完成，并经过测试，正准备交给主程序库；d主程序已经更新，主程库修改的重新测试尚未完成；e做了重新测试，问题再现；f做了重新测试，所做的修改无故障，“软件问题报告”被关闭；g留待以后关闭。6 报告人【填写

25、“软件问题报告”人员的姓名、地址、电话。7 问题属于什么方面【区分是程序的问题，还是模块的问题，或是数据库的问题，文件的问题。也可以能是它们的某种组合。8 模块/子系统【出现的模块名。如果不知是哪个模块，可标出子系统名，尽量给出细节。9 修订版本号【出现问题的模块版本。10 磁带【包含有问题的模块的主程序和磁带的标识符。11 数据库【当发现问题时所使用数据库的标识符。12 文件号【有错误的文件的编号。13 测试用例【发现错误时所使用测试用例的标识符。14 硬件【发现错误时所使用的计算机系统的标识。15 问题描述/影响【问题症兆的详细描述。如果可能，则写明实际问题的所在。也要给出该问题对将来测试、接口软件和文件等的影响。16 附注【记载补充信息。一十三. 软件修改报告【由软件配置管理部门为该报告规定的编号。【软件配置管理部门登记“软件修改报告”的日期。3 时间【准备好“软件修改报告”的日期。