史上最详细软件开发设计文档范文.docx

史上最详细软件开发设计文档范文 系统规约说明书（System Specification ）一引言 A. 文档的范围和目的 B. 概述 1目标 2约束 二功能和数据描述 A. 系统结构 1结构关系图 2结构关系图描述 三子系统描述 A. 子系统 N 的结构图规约说明 B. 结构字典 C. 结构连接图和说明 四系统建模和模拟结构 A. 用于模拟的系统模型 B. 模拟结果 C. 特别性能 五软件项目问题 A. 软件项目可行性探讨报告 B. 软件项目安排 六附录软件项目可行性探讨报告（Report for Feasibility Study ）一引言 1编写目的（阐明编写可行性探讨报告的目的，指出读者对象）2项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。）3定义（列出文档中用到的特地术语的定义和缩略词的原文。）4参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二可行性探讨的前提 1 要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）平安与保密要求；（7）与软件相关的其他系统；（8）完成期限。）2 目标（可包括：（1）人力与设备费用的节约；（2）处理速度的提高；（3）限制精度和生产实力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。）3 条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和运用限制；（4）法律和政策方面的限制；（5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源；（7）建议开发软件投入运用的最迟时间。）4 可行性探讨方法 5 确定可行性的主要因素 三对现有系统的分析 1处理流程和数据流程 2工作负荷 3费用支出（如人力、设备、空间、支持性服务、材料等项开支。）4人员（列出所需人员的专业技术类别和数量。）5设备 6局限性（说明现有系统存在的问题以及为什么须要开发新的系统。）四所建议技术可行性分析 1对系统的简要描述 2处理流程和数据流程 3与现有系统比较的优越性 4采纳建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响 （3）对用户的影响 （4）对系统运行的影响 （5）对开发环境的影响 （6）对运行环境的影响 （7）对经费支出的影响 5技术可行性评价（包括：（1）在限制条件下，功能目标是否能够达到；（2）利用现有技术，功能目标能否达到；（3）对开发人员数量和质量的要求，并说明能否满意；（4）在规定的期限内，开发能否完成。）五所建议系统经济可行性分析 1指出 （1）基建投资 （2）其他一次性支出 （3）常常性支出 2效益 （1）一次性收益 （2）常常性收益 （3）不行定量收益 3收益/投资比 4投资回收周期 5敏感性分析（指一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置改变对支出和效益的影响等的分析。）六社会因素可行性分析 1法律因素（如，合同责任、侵扰专利权、侵扰版权等问题的分析。）2用户运用可行性（如，用户单位的行政管理、工作制度、人员素养等能否满意要求。）七其他可供选择的方案（逐个阐明其他可供选择的方案，并重点说明未被举荐的理由。）八结论看法（可能是：（1）可着手组织开发；（2）需待若干条件（如资金、人力设备等）具备后才能开发；（3）需对开发目标进行某些修改；（4）不能进行或不必进行（如技术不成熟，经济上不合算等）；（4）其他。） 软件项目安排（Software Project Plan ）一引言 1编写目的（阐明编写软件安排的目的，指出读者对象。）2项目背景（可包括：（1）项目托付单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）3定义（列出本文档中用到的特地术语的定义和缩略词的原文。）4参考资料（可包括：（1）项目经核准的安排任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二项目概述 1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能 性能等. 若不编写可行性探讨报告,则应在本节给出较具体的介绍。) 2. 条件与限制（阐明为完成项目应具备的条件 开发单位已具备的条件以及尚需创建的条件. 必要时还应说明用户及分合同承包者担当的工作 完成期限及其它条件与限制。）3. 产品（1）程序（列出应交付的程序名称 运用的语言及存储形式。）（2）文档（列出应交付的文档。）（3）运行环境（应包括硬件环境 软件环境。）4服务（阐明开发单位可向用户供应的服务. 如人员培训 安装 保修 维护和其他运行支持。）5验收标准 三实施安排 1任务分解（任务的划分及各项任务的负责人。）2进度（按阶段完成的项目,用图表说明起先时间 完成时间。）3预算 4关键问题（说明可能影响项目的关键问题,如设备条件 技术难点或其他风险因素,并说明对策。）四人员组织及分工 五交付期限 六专题安排要点（如测试安排 质量保证安排 配置管理安排 人员培训安排 系统安装安排等。） 需求规格说明书（Requirements Specification ）一引言 1 编写目的（阐明编写需求说明书的目的,指明读者对象。）2 项目背景（可包括：（1）项目的托付单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3 定义（列出文档中用到的特地术语定义和缩写词的原文。）4 参考资料（可包括：（1）项目经核准的安排任务书,合同或上机机关的批文；（2）项目开发安排；（3）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）二任务概述 1目标 2运行环境 3条件与限制 三数据描述 1 静态数据 2 动态数据（包括输入数据和输出数据。）3 数据库描述（给出访用数据库的名称和类型。）4 数据词典 5 数据采集 四功能需求 1功能划分 2功能描述 五性能需求 1数据精确度 2时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）3适应性（在操作方式 运行环境 与其他软件的接口以及开发安排等发生改变时，应具有的适应实力。）六运行需求 1用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）2硬件接口 3软件接口 4故障处理 七其他需求（如可运用性、平安保密、可维护性、可移植性等。） 概要设计说明书（Architectural Design Specification ）一引言 1编写目的（阐明编写概要设计说明书的目的，指明读者对象。）2项目背景（可包括：（1）项目的托付单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3定义（列出文档中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目经核准的安排任务书，合同或上机机关的批文；（2）项目开发安排；（3）需求规格说明书；（4）测试安排（初稿）；（5）用户操作手册（初稿）；（6）文档所引用的资料、采纳的标准或规范。）二任务概述 1目标 2运行环境 3需求概述 4条件与限制 三总体设计 1处理流程 2总体结构和模块外部设计 3功能安排（表明各项功能与程序结构的关系。）四接口设计 1外部接口（包括用户界面 软件接口与硬件接口。）2内部接口（模块之间的接口。）五数据结构设计 1 逻辑结构设计 2 物理结构设计 3 数据结构与程序的关系 六运行设计 1运行模块的组合 2运行限制 3运行时间 七出错处理设计 1出错输出信息 2出错处理对策（如设置后备、性能降级、复原及再启动等。）八平安保密设计 九维护设计（说明为便利维护工作的设施,如维护模块等。）具体设计说明书（Procedural Design Specification ）一引言 1 编写目的（阐明编写具体设计说明书的目的,指明读者对象。）2 项目背景（应包括项目的来源和主管部门等。）3 定义（列出文档中用到的特地术语定义和缩写词的原意。）4 参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的安排任务书,合同或批文；（2）项目开发安排；（3）需求规格说明书；（3）概要设计说明书；（4）测试安排(初稿)；（5）用户操作手册(初稿)；（5）文档所引用的其他资料、软件开发标准或规范。）二总体设计 1需求概述 2软件结构（如给出软件系统的结果图。）三程序描述（逐个模块给出以下的说明:：）1功能 2性能 3输入项目 4输出项目 5算法（模块所选用的算法。）6程序逻辑（具体描述模块实现的算法，可采纳:：（1）标准流程图；（2）PDL 语言；（3）N-S 图；（4）PAD；（5）判定表等描述算法的图表。）7接口 8存储安排 9限制条件 10 测试要点（给出测试模块的主要测试要求。）用户操作手册（User Guide ）一引言 1编写目的（阐明编写手册的目的，指明读者对象。）2项目背景（说明项目的来源、托付单位、开发单位及主管部门。）3定义（列出手册中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的安排任务书,合同或批文；（2）项目开发安排；（3）需求规格说明书；（4）概要设计说明书；（5）具体设计说明书；（6）测试安排；（7）手册中引用的其他资料、采纳的软件工程标准或软件工程规范。）二软件概述 1目标 2功能 3性能 （1）数据精确度（包括输入、输出及处理数据的精度。）（2）时间特性（如响应时间、处理时间、数据传输时间等。）（3）敏捷性（在操作方式、运行环境需做某些变更时软件的适应实力。）三运行环境 1硬件（列出软件系统运行时所需的硬件最小配置，如：（1）计算机型号、主存容量；（2）外存储器、媒体、记录格式、设备型号及数量；（3）输入、输出设备；（4）数据传输设备及数据转换设备的型号及数量。）2支持软件（如：（1）操作系统名称及版本号；（2）语言编译系统或汇编系统的名称及版本号；（3）数据库管理系统的名称及版本号；（4）其他必要的支持软件。）四运用说明 1安装和初始化（给出程序的存储形式、操作吩咐、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件工具等。）2输入（给出输入数据或参数的要求。）（1）数据背景（说明数据来源、存储媒体、出现频度、限制和质量管理等。）（2）数据格式（如：（1）长度（2）格式基准（3）标号（4）依次（5）分隔符（6）词汇表（7）省略和重复（8）限制。）（3）输入举例 3输出（给出每项输出数据的说明。）（1）数据背景（说明输出数据的去向、运用频度、存放媒体及质量管理等。）（2）数据格式（具体阐明每一输出数据的格式,如:首部 主体和尾部的详细形式。）（3）举例 3出错和复原（给出：（1）出错信息及其含义（2）用户应实行的措施，如修改、复原、再启动。）4求助查询（说明如何操作。）五运行说明 1 运行表 列出每种可能的运行状况,说明其运行目的. 2 运行步骤 按依次说明每种运行的步骤,应包括: （1）运行限制 （2）操作信息（1）运行目的（2）操作要求（3）启动方法（4）预料运行时间（5）操作吩咐格式及说明（6）其他事项。）（3）输入/输出文件（给出建立和更新文件的有关信息，如：（1）文件的名称及编号（2）记录媒体（3）存留的书目（4）文件的支配说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密限制等。）（4）启动或复原过程 六特别规过程（供应应急或特别规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和留意事项。）七操作吩咐一览表 （按字母依次逐个列出全部操作吩咐的格式 功能及参数说明。）八程序文件（或吩咐文件）和数据文件一览表（按文件名字母依次或按功能与模块分类依次逐个列出文件名称、标识符及说明。）九用户操作举例 测试安排（Test Plan ）一、引言 1 编写目的（阐明编写测试安排的目的,指明读者对象。）2 项目背景（说明项目的来源 托付单位及主管部门。）3 定义（列出测试安排中用到的特地术语定义和缩写词的原意。）4 参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的安排任务书，合同或批文；（2）项目开发安排；（3）需求规格说明书；（3）概要设计说明书；（4）具体设计说明书；（5）用户操作手册; g 本测试安排中引用的其他资料 采纳的软件开发标准或规范。）二任务概述 1目标 2运行环境 3需求概述 4条件与限制 三安排 1测试方案（说明确定测试方法和选取测试用例的原则。） 2测试项目（列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。） 3测试打算 4测试机构及人员（测试机构名称 负责人和职责。）四测试项目说明（按依次逐个对测试项目做出说明：） 1测试项目名称及测试内容 2测试用例 （1）输入（输入的数据和输入的吩咐。）（2）输出（预期的输出数据。）（3）步骤及操作 （4）允许偏差（给出实测结果与预料结果之间允许偏差的范围。）3 进度 4 条件（给出项测试对资源的特别要求，如设备、软件、人员等。）5 测试资料（说明项测试所需的资料。）五评价 1范围（说明所完成的各项测试说明问题的范围及其局限性。）2准则（说明评价测试结果的准则。）测试分析报告（Test Specification ）一引言 1编写目的（阐明编写测试分析报告的目的，指明读者对象。）2项目背景（说明项目的来源、托付单位及主管部门。）3定义（列出测试分析报告中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的安排任务书，合同或批文；（2）项目开发安排；（3）需求规格说明书；（4）概要设计说明书；（5）具体设计说明书；（6）用户操作手册；（7）测试安排；（8）测试分析报告所引用的其他资料、采纳的软件工程标准或软件工程规范。）二测试安排执行状况 1测试项目（列出每一测试项目的名称、内容和目的。）2测试机构和人员（给出测试机构名称、负责人和参加测试人员名单。）3测试结果（按依次给出每一测试项目的：（1）实测结果数据（2）与预期结果数据的偏差（3）该项测试说明的事实（4）该项测试发觉的问题。）三软件需求测试结论（按依次给出每一项需求测试的结论。包括：（1）证明的软件实力（2）局限性（即项需求未得到充分测试的状况及缘由）。）四评价 1软件实力（经过测试所表明的软件实力。）2缺陷和限制（说明测试所揭露的软件缺陷和不足,以及可能给软件运行带来的影响。）3建议（提出为弥补上述缺陷的建议。）4测试结论（说明能否通过。） 开发进度月报一报告时间及所处的开发阶段 二给出进度 1 本月内的主要活动 2 实际进展与安排比较 三所用工时（按不同层次人员分别计时。）四全部机时（按全部计算机机型分别计时。）五经费支出（分类列出本月经费支出项目,给出支出总额，并与安排比较。）六工作遇到的问题及实行的对策 七本月完成的成果 八下月的工作安排 九特别问题项目开发总结报告一引言 1编写目的（阐明编写总结报告的目的,指明读者对象。）2项目背景（说明项目的来源、托付单位、开发单位及主管部门。）3定义（列出报告中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的安排任务书，合同或批文；（2）项目开发安排；（3）需求规格说明书；（4）概要设计说明书；（5）具体设计说明书；（6）用户操作手册；（7）测试安排；（8）测试分析报告（9）本报告引用的其他资料、采纳的开发标准或开发规范。）二开发结果 1 产品（可包括：（1）列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；产品文档名称等。）2 主要功能及性能 3 所用工时（按人员的不同层次分别计时。）4 所用机时（按所用计算机机型分别计时。）5 进度（给出安排进度与实际进度的对比。）6 费用 三评价 1生产率评价（如平均每人每月生产的源程序行数、文档的字数等。）2技术方案评价 3产品质量评价 四阅历与教训软件修改报告一登记号（由软件配置管理部门为该报告规定的编号。）二登记日期（软件配置管理部门登记软件修改报告的日期。）三时间（打算好软件修改报告的日期。）四报告人（填写该报告的作者。）五子系统名（受修改影响的子系统名。）六模块名（被修改的模块名。）七软件问题报告的编号（被软件修改报告处理或部分处理的软件问题报告的编号。）八修改（包括程序修改、文件更新、数据库修改或他们的组合。）九修改描述（修改的具体描述。假如是文件更新或数据库修改，还要列出文件更新通知或数据库修改申请的标识符。）十批准人（批准人签字，正式批准进行修改。）十一 语句类型（程序修改中涉及到的语句类型，包括：输入/输出语句类、计算语句类、逻辑限制语句类、数据处理语句类(如数据传送 存取语句类)。）十二 程序名（被修改的程序、文件或数据库名字。）十三 老修订版（当前的版本/修订本标识。）十四 新修订版（修改后的版本/修订本标识。）十五 数据库（假如申请数据库修改,则给出数据库的标识符。）十六 数据库修改报告（数据库修改申请号。）十七 文件（假如要求对文件进行修改，则给出文件的名字。）十八 文件更新（文件更新通知单的编号。）十九 修改是否已测试（指出已对修改做了哪些测试，如单元、子系统、组装、确认和运行测试等，并注明测试胜利与否。）二十 软件问题报告是否给出问题的精确描述 二十一 问题注释（精确地叙述要维护的问题。）二十二 问题源（指明问题来自于哪里。）二十三 资源（完成修改所需资源的估计，即总的人时数和计算机时间的开销。）