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

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

计算机软件开发文档编写指南计算机软件开发文档编写指南共列出了+三种文档的内容要求及其简要说明。包括:

《可行性研究报告》、《项目开发计划》、《需求规格说明书》、《概要设计说明书》、《详细设计说明书》、《用户操作手册》、《测试报告》、《开发进度阶段报告》、《项目开发总结报告》、《程序维护手册》、《软件问题报告和软件修改报告》。各文档内容大纲由带编号的标题构成,标题后方括号内

为其说明。这里给出一个统一的封面格式:

保密级别:__________

文档编号_________________

版本号__________________

文档名称:___________________________

项目名称:____________________________

项目负责人:_________________________

编写___________ ________ 年_______月________日

校对___________ ________ 年_______月________日

审核___________ ________ 年_______月________日

批准___________ ________ 年_______月________日

开发单位_____________________

一、可行性研究报告

1. 引言

1.1编写目的【阐明编写可行性研究报告的目的,指出读者对象。】

1.2项目背景【应包括:a.所建议开发软件的名称;b.项目的任务提出者、开发者、用户及实

现软件的单位;C.项目与其他软件或其他系统的关系】

1.3定义【列出文档中用到的专问术语的定义和缩写词的原文。】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包

括:a. 页目经核准的计戈任务书、合同或上级机关的批文;b.与项目有关的已发表的资料;

c. 文档中所引用的资料,所采用的软件标准或规范】

2. 可行性研究的前提

2.1要求【列出并说明建议开发软件的基本要求,如a.功能;b.性能;c.输出;d.输入;

e. 基本的数据流程和处理流程;

f.安全与保密要求;

g.与软件相关的其他系统;

h.

完成期限。】

2.2 目标【可包括:a.人力与设备费用的节省;b.处理速度的提高;c. 控制精度或生产能

力的提高;d.管理信息服务的改进;e,决策系统的改进;f.人员工作效率的提高,

等等。】

2.3条件、假定和限制【可包括:a. 建议开发软件的最短命;b.进行系统方案选择比较的期

限;c. 经费来源和使用限制;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对现有软件的影响

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 敏感性分析[敏感性分析是指一些关键性因素,如:系统生存周期长短、系统工作负荷量

处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。]

5. 社会因素可行性分析

6.1 法律因素[如:合同责任、侵犯专利权、侵犯版权等问题的分析。]

6.2 用户使用可行性【如,用户单位的行政管理、工作制度、人员素质等能否满足要求】

7. 其他可供选择的方案

【逐个阐明其他可供选择的方案,并重点说明未被推荐的理由。】

8. 结论意见

【结论意见可能是:a. 可着手组织开发;b.需待若干条件(如资金、人力、设备等)具备后才能开发;c. 需对开发目标进行某些修改;d.不能进行或不必进行(如技术不成熟,经济上不合算等);e. 其他。】

二、项目开发计划

1. 引言

1.1编写目的【阐明编写开发计划的目的,指出读者对象。】

1.2项目背景【可包括:a. 项目的委托单位、开发单位和主管部门;b.该软件系统与

其他系统的关系。】

1.3定义【列出本档中用到的专门术语的定义和缩写词的原文。】

1.4参考资料【可包括:a. 项目经核准的计划任务书、合同或上级机关的批文;b. 文档所

引用的资料、规范等;列出这些资料的作者、标题、编号、发表日期、出版单位或资

料来源。】

2. 项目概述

2.1工作内容【简要说明项目的各项主要工作,介绍所开发软件的功能、性能等。若不编

写可行性研究报告,则应在本节给出较详细的介绍。】

2.2条件与限制【阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造

的条件。必要时还应说明用户及分合同承包者承担的工作、完成期限及其他条件与

限制。】

2.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. 专题计划要点

【如测试计划、质量保证计划、配置管理计划、人员培训+划、系统安装计划等。】

三、需求规格说明书

1. 引言

1.1编写目的【阐明编写需求说明书的目的,指明读者对象。】

1.2项目背景【应包括:a. 项目的委托单位、开发单位和主管部门,b,该软件系统与其

他系统的关系。】

1.3定义【列出文档中所用到的专门术语的定义和缩写词的原文。】

1.4参考资料【可包括:a,项目经核准的计划任务书、合同或上级机关的批文;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时间特性【如响应时间、更新处理时间、数据转换与传输时间、运行时间等。】

5.3适应性【在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时.应

具有的适应能力】

6. 运行需求

6.1用户界面【如屏幕格式、报表格式、菜单格式、输入输出时间等】

6.2硬件接口

6.3软件接口

6.4故障处理

7. 其他需求

【如可使用性、安全保密、可维护性、可移植性等】

四、概要设计说明书

1. 引言

1.1编写目的【阐明编写概要设计说明书的目的,指明读者对象。】

1.2项目背景【应包括:a. 目的委托单位、开发单位和主管部门;b.该软件系统与其他

系统的关系。】

1.3定义【列出本文档中所用到的专门术语的定义和缩写同的原意。】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,

可包括:a. 项目经核准的计划任务书、合同或上级机关的批文;b.项目开发计

划;C. 需求规格说明书;d. 测试计划(初稿);e. 用户操作手册(初稿);f.文档

所引用的资料、采用的标准或规范】

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. 引言

1.1编写目的【阐明编写详细设计说明书的目的,指明读者对象】

1.2项目背景【应包括项目的来源和主管部门等。】

1.3定义【列出文档中所用到的专门术语的定义和缩写词内的原意。】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料

源,可括括:a. 项目的计划任务书、合同或批文;b.项目开发计划;C. 需

求规格说明书;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.8存储分配

3.9限制条件

3.10测试要点【给出测试模块的主要测试要求。】

六、用户操作手册

1. 引言

1.1编写目的【阐明编写手册的目的。指明读者对象。】

1.2项目背景【说明项目来源、委托单位、开发单位及主管部门】

1.3 定义【列出手册中使用的专门术语的定义和缩写词的原意】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,

可包括:a.项目的计划任务书、合同或批文;b.项目开发计划;C. 需求规格说

明书;d.概要设计说明书;e。详细设计说明书;f.测试计划;g。手册中引用

的其他资料、采用的软件工程标准或软件工程规范。】

2. 软件概述

2.1目标

2.2功能

2.3 性能

a.数据精确度【包括输入、输出及处理数据的精度】

b.时间特性【如响应时间、处理时间、数据传输时间等。】

c.灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。】

3. 运行环境

3.1硬件【列出软件系统运行时所需的硬件最小配置,如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.顺序;e。分隔符;f.

词汇表;g. 省略和重复;h.控制。】

4.2.3输入举例

4.3输出【给出每项输出数据的说明】

4.3.l数据背景【说明输出数据的去向使用频度、存放媒体及质量管理等。】

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.文件的支配

【说明确定保留文件或废弃文件的准则,分发文件的对象,占用硬件的优先

级及保密控制等.】

5.2.4启动或恢复过程

6. 非常规过程

【提供应急或非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。】

7. 操作命令一览表

【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。】

8. 程序文件(或命令文件)和数据文件一览表

【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。】

9. 用户操作举例

七、测试计划

1. 引言

1.l编写目的【阐明编写测试计划的目的并指明读者对象。】

1.2项目背景【说明项目的来源、委托单位及主管部门。】

1.3定义【列出测试计划中所用到的专门术语的定义和缩写词的原意。】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料

来源,可包括:a·项目的计划任务书、合同或批文;b.项目开发计划;c,

需求规格说明书;d.概要设计明书;e·详细设计说明书;f.用户操作手册;

g.测试计划中引用的其他资料、采用的软件开发标准或规范。】

2. 任务概述

2.1目标

2.2运行环境

2.3需求概述

2.4条件与限制

2.5测试资料[说明项测试所需的资料]

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条件【给出项测试对资源的特殊要求,如设备、软件、人员等。】

5. 评价

5.1范围[说明所完成的各项测试说明问题的范围及其局限性。]

5.2准则[说明评价测试结果的准则。]

八、测试分析报告

1. 引言

1.1编写目的【阐明编写测试分析报告的目的井指明读者对象。】

1.2项目背景【说明项目的来源、委托单位及主管部门】

1.3定义【列出测试分析报告中用到的专门术语的定义和缩写同的原意】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,

可包括:a。项目的计划任务书、合同或批文;b.项目开发计划;c。需求规格说明

书;d.概要设计说明书;e,详细设计说明书;f.用户操作手册;g.测试计划;h.

测试分析报告所引用的其他资料、采用的软件工程标准或软件工程规范。】

2. 测试计划执行情况

2.1测试项目【列出每一测试项目的名称、内容和目的。】

2.2测试机构和人员【给出测试机构名称、负责人和参与测试人员名单。】

2.3测试结果【按顺序给出每一测试项目的:a。实测结果数据;b.与预期结果数据的偏

差;C。该项测试表明的事实;d.该项测试发现的问题。】

3. 软件需求测试结论

【按顺序给出每一项需求测试的结论。包括:a。证实的软件能力小; b.局限性(即项需求未得到充分测试的情况及原因)。】

4. 评价

4.1软件能力【经过测试所表明的软件能力。】

4.2缺陷和限制【说明测试所揭露的软件缺陷和不足,以及可能给软件运行带来的影

响】

4.3建议【提出为弥补上述缺陷的建议。】

4.4测试结论【说明能否通过。】

九. 开发进度阶段报告

1. 报告时间及所处的开发阶段

2. 工程进度

2.1本月内的上要活动

2.2实际进展计划比较

3. 所用工时

【按不同层次人员分别计时】

4. 所用机时

【按所用计算机机型分别计时。】

5. 经费支出

【分类列出本月经费支出项目,给出支出总额,并与计划比较。】

6. 工作遇到的问题及采取的对策

7. 本月完成的成果

8. 下月的工作计划

9. 特殊问题

十、项目开发总结报告

1. 引言

1.1编写目的【阐明编写总结报告的目的并指明读者对象。】

1.2项目背景【说明项目来源、委托单位、开发单位及主管部门。】

1.3定义【列出报告用到的专门术语的定义和缩写词的原意。】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来

源,可包括:a,项目经核准的计划任务书、合同或上级机关的批文;b.项目

开发计划;C,需求规格说明书;d.概要设计说明书;e。详细设计说明书;f.

用户操作手册;g。测试计划;h;测试分析报告;I.本报告引用的其他资料、

采用的开发标准或开发规范。】

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编写目的【阐明编写手册的目的并指明读者对象。】

1.2开发单位【说明项目的提出者、开发者、用户和使用场所。】

1.3定义【列出报告用到的专门术语的定义和缩写词的原意。】

1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料

来源,以及保密级别,可包括:a。用户操作手册;b.与本项目有关的其他

文档。】

2. 系统说明

2.1系统用途【说明系统具备的功能,输入和输出。】

2.2安全保密【说明系统安全保密方面的考虑。】

2.3总体说明【说明系统的总体功能,对系统、子系统和作业做出综合性的介

绍,并用图表的方式给出系统主要部分的内部关系。】

2.4程序说明【兑明系统中每一程序、分程宁的细节和特性。】

2.4.1程序1的说明

2.4.1.1功能【说明程序的功能。】

2.4.1.2方法【说明实现方法。】

2.4.1.3输入【说明程序的输入、媒体、运行数据记录、运行开始时使

用的输入数据的类型和存放单元、与程序初始化有关的入口

要求。】

2.4.1.4处理【处理特点和目的,如:a。用图表说明程序的运行的逻

辑流程;b.程序主要主要转移条件;。。对程序的约束条件;d.

程序结束时的出口要求:e·与下一个程序的通信与联结(运行

、控帘h{。由该程序产生并供处理程序段使用的输出数据

类型和存放单元。g,程序运行所用存储量、类型及存储位

置等。】

2.4.1.5输出【程序的输出】

2.4.1.6接口【本程序与本系统其他部分的接口。】

2.4.1.7表格【说明程序内部的各种表、项的细节和特性,对每张表

的说明至少包括: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.使闲这些数据库的程序;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.标准化的数据元素及其特征。】

4.2验证过程【说明一个程序段修改后,对其进行验证的要求和过程(包括测试程

序和数据)及程序周期性验证的过程。】

4.3出错及纠正方法【列出出错状态及其纠正方法。】

4.4专门维护过程【说明文档其他地方没有提到的专门维护过程,如:a,维护该

软件系统的输入输出部分(如数据库)的要求、过程和验证方法;b.运行程

序库维护系统所必需的要求、过程和验证方法;C。对闰年、世纪变更所需要的临时性修改等。】

4.5专用维护程序【列出维护软件系统使用的后备技术和专用程序(如文件恢复程

序、淘汰过时文件的程序等)的目录,并加以说明,内容包括:a。维护作业的输入输出要求;b.输入的详细过程及在硬设备上建立、运行并完成维护作业

的操作步骤。】

4.6程序清单和流程图【引用资料或提供附录给出程序清单和流程图。】

1. 登记号

【由软件配置管理部门为该报告规定一个唯一的、顺序的编号】

2.登记日期

【软件配置管理部门登记该报告的日期。】

3.问题发现日期

【发现该问题的日期和时间。】

4. 活动

【在哪个阶段发现的问题,分为单元测试、组装测试、确认测试和运行维护。】

5. 状态

【在软件配置记录中维护的动态指示,状态表示有:a。正在复查“软件问题报

告”,以确采取什么行动;b.“软件问题报告”已由指定的人去进行处理;c.修

改已完成,并经过测试,正准备交给主程序库;d.主程序库已经更新,主程序

库修改的重新测试尚未完成;e。做了重新测试,问题再现;f.做了重新测试,

所做的修改无故障,“软件问题报告”被关闭;g.留待以后关闭】

6. 报告人

【填写“软件问题报告”人员的姓名、地址、电话。】

7. 问题属于什么方面

【区分是程序的问题,还是模块的间题,或是数据库的问题,文件的问题。也可

能是它们的某种组合。】

8. 模块/子系统

【出现的模块名。如果不知是哪个模块,可标出子系统名,尽量给出细节。】

9. 修订版本号

【出现问题的模块版本。】

10. 磁带

【包含有问题的模块的主程序库的磁带的标识符。】

11. 数据库

【当发现问题时所使用数据库的标识符。】

12. 文件号

【有错误的文件的编号。]

13. 测试用例

【发现错误时所使用测试用例的标识符。】

14. 硬件

【发现错误时所使用的计算机系统的标识。】

15. 问题描述/影响

【问题症兆的详细描述。如果可能,则写明实际问题所在。也要给出该问题对将

来测试、接口软件和文件等的影响。】

16. 附注

【记载补充信息。】

1. 登记号

【由软件配置管理部门为该报告规定的编号】

2. 登记日期

【软件配置管理部门登记“软件修改报告,’的日期。】

3. 时间

【准备好“软件修改报告”的日期】

4. 报告人

【填写该报告的作者。】

5. 子系统名

【受修改影响的子系统名。】

6. 模块名

【被修改的模块名。】

7. “软件问题报告”的编号

【被“软件修改报告”处理或部分处理的“的编号。如果某“软件问题报告”

的问题只是部分被处理,则在编号后附以p,如1234P。】

8. 修改

【包括程序修改、文件更新、数据库修改或它们的组合。】

9. 修改描述

【修改的详细描述。如果是文件更新或数据库修改,还要列出文件更新通知或数据库修改申请的标识符。]

10. 批准人

【批准人签字,正式批准进行修改。】

11. 语句类型

【程序修改中涉及到的语句类型,包括:输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类(如数据传送、存取语句类)。】

12. 程序名

【被修改的程序、文件或数据库的名字。】

13. 老修订版

【当前的版本/修订本标识】

14. 新修订版

【修改后的版本/修词本标识】

15. 数据库

【如果申请数据库修改,则给出数据库的标识符。】

16. 数据库修改报告

【数据库修改申请号。】

17. 文件

【如果要求对文件进行修改,则给出文件的名字。】

18. 文件更新

【文件更新通知单的编号。】

19. 修改是否已测试

【指出己对修改做了哪些测试,如单元、子系统、组装、确认和运行测试等,并注明测试成功与否】

20. “软件问题报告”是否给出问题的准确描述

【回答‘是’或‘否’】

21. 问题注释

【准确地叙述要维护的问题。】

22. 问题源

【指明问题来自于哪里,如软件需求说明书、设计说明书、数据库、源程序等。】

23. 资源

【完成修改所需资源的估计,即总的人时数和计算机时间的开销】

(国内标准)GB-软件开发主要文档编写规范

231 GB 8567-88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567-88中主要软件文档的编写说明,供编写时参考。这些文档主要是:可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明:说明本可行性研究报告的编写目的,指出预期的读者。 1.2 背景 说明: a .所建议开发的软件系统的名称。 b .本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c .该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料,如: a .本项目的经核准的计划任务书或合同、上级机关的批文。 b .属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料,包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提,如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求,如: a .功能。 b .性能。 c .输出如报告、文件或数据,对每项输出要说明其特征,如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e .处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程,并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标,如: a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。

软件开发流程

快视信息软件开发流程规范: 用户需求:软件项目首先由客户经理(CM,Custom Management)接洽客户的较大的需求。这时的需求叫市场需求(或叫用户需求),客户经理会进行各个项目的安排,即对项目的启动时间和发布时间进行规划和设置。 项目经理(PM,Project Management)对客户经理负责。项目经理的需求是根据客户经理给的,项目经理不和用户(客户)直接接触(通过客户经理接触),负责和用户进行需求洽谈和沟通的是客户经理。一个项目的需求在一般情况下是不准变更的,如果有需求理解方面的不清楚可以进行沟通,但是需求是不变更的。如果用户有新的需求,一般规划在下一个版本中。因为需求变更了,这个目的时间就要进行调整,就不能按计划进行和完成。客户经理提交给项目经理的是需求规格说明书。 一、项目开工会 在项目经理领到客户经理分配给的需求后,做项目计划,具体做项目人员的确定、需求的分解(需求分解到每个人)、代码量的估计,项目各个阶段时间的划分和工作量的计划、质量指标的设定。这时项目经理需要输出的文档是项目需求分解任务书、项目计划PPT、及做好整个项目需要填写的一系列表格。然后组织项目组成员和客户经理CM、QA(质量审计经理)进行项目开工会。这时这个项目就算真正启动,计算工作量时,即计算这个项目总共花了多少个工时,工时是项目经理做计划的时间也算在内,再加上项目开工会和后续各个阶段总共花的总工时数,还有各个阶段开会所花的时间。在项目开工会上,各个成员就明确了这个项目是属于增强型项目,还是其他项目的项目性质,增强型项目的意思是说在原来上一版本的基础上又根据新的需求进行增强型开发。还有要明确项目最后开发出的新增代码量有多少,最后要明确每个人的需求任务,接下来着手进行SRS的写作。 二、SRS阶段:System/Software Requirment Specification 软件需求规格说明 在项目开工会后,项目组就开始按照在项目开工会上项目经理的需求任务分解的任务开始进行SRS的写作。 一般项目经理给你的一个子需求任务,你这时需要分解为更小的需求。一般一个需求的写作是按这样进行的。先简单介绍这个需求,然后把这个需求设计成黑盒的形式,即输入,处理过程、输出。这些都需要写详细,任何一个需求都写成这种形式,输入是什么,处理过程是什么,输出结果是什么。处理过程需要用Visio或者PPT画出处理流程图,流程图要很详细。每一步的各种情况都要表示和考虑到。对异常情况也要考虑和进行处理。还有要说明在原来的基础上怎么改动,具体方法要进行说明。设计的数据库表结构,要给出脚本,SQL语句,表结构需说明每个字段,哪些是主键,你在这个需求处理过程中哪里使用了哪些表,需要进行哪些操作,都需要说明。这里需要设计和编制《数据库设计说明书》文档。该文档中描述该系统中设计出的所有的数据库表结构和各字段类型。还有多个操作对象要画序列图表示出按时序的处理过程。这个SRS文档就相当于我们平时毕业设计或者一个题目的详细设计阶段达到的水平,甚至比它更详细。每个项目组成员都把自己的需求的SRS文档写出来之后放到配置库中,然后每个人对项目组其他成员的(非自己的)SRS文档进行Review(评审),对每个SRS文档在每页发现或者纠正的错误数不能低于一定的数目,而且要保留批注记录,经过Review的(保留批注的)文档要放到配置库的Review文件夹下,这是进行项目质量指标收集的重要依据,是QA 进行调阅和审计的资料。项目经理要对SRS文档、SRS Review文档进行汇总。在汇总后组织项目组全体成员进行SRS阶段会议,对每个人写的SRS进行评审会议(讨论和提意见),对别人给你提的修改意见你要一一进行说明,说明为什么不改,怎么改的,是什么问题,问题严重程度属于什么级别,而且都要填表,也是QA进行审计的内容。开完会后如果每个人完成的都差不多,然后安排半天或者一天的时间进行返工,主要是进行修改文档,按在会上讨论的结果和别人给你的Review 文档结果(评审结果)进行准一修改和完善。然后再进行SRS阶段开会,如果都做的比较到位和具体、符合要求,即关闭SRS阶段。这时SRS阶段的花费的工时数和一些质量活动指标就出来了,比如你这个SRS文档写了几页,每页的错误数是多少,返工修改用了多少时间,然后这些这个比率也会自动计算出来。进而可以判断这个阶段的质量。每个项目组成员在每天工作完毕后都要进行Time Sheet 的填写,必须具体到半个小时,这是统计和分析的需要。填写必须真实。 三、UTP、STP阶段(UTP、STP写作) UTP Unit Test Plan 单元测试计划 STP System Test Plan

软件开发文档规范

附2: 软件文档编写向导 文档分类 项目包括如下几类文档: 项目管理文档。包括:《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括:《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括:《用户操作手册》《演示文件》。 软件项目计划 (Software Project Plan) 一?引言 1?编写目的(阐明编写软件计划的目的,指出读者对象。) 2?项目背景(可包括:(1 )项目委托单位、开发单位和主管部门;(2)该软件系统与 其他系统的关系。) 3?定义(列出本文档中用到的专门术语的定义和缩略词的原文。) 4?参考资料(可包括:文档所引用的资料、规范等;列出资料的作者、标题、编号、发 表日期、出版单位或资料来源。) 二?项目概述 1.工作内容(简要说明项目的各项主要工作,介绍所开发软件的功能性能等?若不编写可行性研究报告,则应在本节给出较详细的介绍。) 2.条件与限制(阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的 条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。) 3.产品 (1)程序(列出应交付的程序名称使用的语言及存储形式。) (2)文档(列出应交付的文档。) (3 )运行环境(应包括硬件环境软件环境。) 4?服务(阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准

三.实施计划 1.任务分解(任务的划分及各项任务的负责人。) 2?进度(按阶段完成的项目,用图表说明开始时间完成时间。) 3?预算 4?关键问题(说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。) 四.人员组织及分工 五.交付期限 六.专题计划要点(如测试计划等。) 项目开发进度报告 一.报告时间及所处的开发阶段 二.给出进度 1.本周的主要活动 2.实际进展与计划比较 三.所用工时(按不同层次人员分别计时。) 四.所有机时 五.工作遇到的问题及采取的对策 六.本周完成的成果 七.下周的工作计划 八.特殊问题 项目开发总结报告 一.引言 1.编写目的(阐明编写总结报告的目的,指明读者对象。) 2.项目背景(说明项目的来源、委托单位、开发单位及主管部门。) 3.定义(列出报告中用到的专门术语定义和缩写词的原意。) 4.参考资料(列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括: (1 )项目开发计划;(2 )需求规格说明书;(3 )概要设计说明书;(4 )详细设计说明

软件开发 软件产品开发文件编制指南

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》(GB 8567—88)是一份指导性文件。它建议在软件的开发过程申编下述14个文件:可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示,它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。 l、可行性研究报告 可行性研究报告的目的是:说明该软件开发项目的实现在技术上、经济上和社会条上的可行性,论述为了合理地达到开发目标而可能选择的各种方案,说明并论证所选定的方案。可行性研究报告的编写内容见表l。 表l 可行性研究报告 2、项目开发计划 编制项目开发计划的目的是用文件的形式,并在开发过程中各项工作的

负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来,以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。 表 2 项目开发计划 3、软件需求说明书 软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解, 使之成为整个软件开发工作的基础。其内容要求见表3。 表3 软件需求说明书 4、数据要求说明书 数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息,其内容要求列于表4中。 表4 数据要求说明书

5、概要设计说明书 概要设计说明书又称为总体设计说明书,编制目的是说明对项目系统的设计考虑,包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等,为程序的详细设计提供基础。其内容要求见表5。 表5 概要设计说明书 6、详细设计说明书 详细设计说明书又称为程序设计说明,编制目的是说明一个软件系统各个层次中的每一个程序(模块)的设计考虑。 如果软件系统比较简单,层次少,本文件可以不单独编写,有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。 表6 详细设计说明书 7、数据库设计说明书

软件开发文档说明书(完整流程)

. 在软件行业有一句话:一个软件能否顺利的完成并且功能是否完善,重要是看这个软件有多少文档,软件开发文档是一个软件的支柱,如果你的开发文档漏洞百出,那么你所开发出来的软件也不可能会好;开发文档的好坏可以直接影响到所开发出来软件的成功与否。 一、软件开发设计文档:软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。 1、软件需求说明书:也称为软件规格说明。该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。软件需求说明书的编制目的的就是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为整个开发工作的基础。 其格式要求如下: 1 引言 1.1 编写目的。 1.2 背景 1.3 定义 2 任务概述 2.1 目标 2.2 用户的特点

. 2.3 假定和约束 3 需求规定 3.1 对功能的规定 3.2 对性能的规定 3.2.1 精度 3.2.2 时间特性的需求 3.2.3 灵活性 3.3 输入输出要求 3.4 数据管理能力要求 3.5 故障处理要求 3.6 其他专门要求 4 运行环境规定 4.1 设备 4.2 支持软件 4.3 接口 4.4 控制

. 2、概要设计说明书:又称系统设计说明书,这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑,包括程序系统的基本处理。流程、程序系统的组织结构、模块划分、功能分配、接口设计。运河行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。 其格式要求如下: 1 引言 1.1 编写目的 1.2 背景 1.3 定义 1.4 参考资料 2 总体设计 2.1 需求规定 2.2 运行环境 2.3 基本设计概念和处理流程 2.4 结构 2.5 功能需求与程序的关系

软件系统开发规范

系统开发规范 1、数据库使用规范 1.1服务器上有关数据库的一切操作只能由服务器管理人员进行。 1.2程序中访问数据库时使用统一的用户、统一的连接文件访问数据库。 1.3原则上每一个频道只能建一个库,库名与各频道的英文名称相一致,库中再包含若干表。比较大的、重点的栏目可以考虑单独建库,库名与栏目的英文名称相一致。 1.4命名: (1)数据库、表、字段、索引、视图等一系列与数据库相关的名称必须全部使用与内容相关的英文单词命名(尽量避免使用汉语拼音),对于一个单词难以表达的,可以考虑用多个单词加下划线(_)连接(不能超过四个单词)命名。 (2)所有的名称必须统一使用英文小写字母。 (3)所有的名称起始和结尾不能使用下划线(_)。 (4)所有的名称不能包含26个英文小写字母和下划线(_)以外的其他字符。 1.5不再使用的数据库、表应删除,在删除之前必须备份(包括结构和内容)。 2、文档规范 所有的项目必须有相关的文档说明(可以是电子文档)。文档应包含如下内容: (1)项目名称。 (2)项目小组名单,项目负责人。 (3)项目开发起始时间和结束时间。 (4)项目内容描述。 (5)项目位置。(在哪个频道、哪个栏目) (6)与项目有关的程序文件名(含路径名),文件内容及实现的功能描述。 (7)完整的程序流程图。

(8)数据库、表、视图、索引的名称,用途。字段的名称、类型、长度、用途,必须附上相关的SQL语句。 3、源代码与页面嵌套规范 3.1源代码: (1)使用自定义变量(包括全局变量、局部变量)之前必须先声明变量,并用注释语句标明变量的类型、用途。 (2)自定义函数必须用注释语句标明函数的用途、参数的数据类型、意义,返回值的类型。 (3)程序中重要的过程或代码较长的过程应使用注释语句标明该过程的起始行和结束行,并注明该过程的功能。 (5)所有的注释文字一律使用简体中文。 3.2 HTML页面嵌套: (1)网页设计部设计的HTML页面以嵌套的方式确定用于动态显示程序执行结果的位置、宽度、行数(或高度)等,并在相应位置予以文字说明。页面中与程序无关的图片、文字、联结等必须使用完整的URL。 (2)软件开发人员和编辑人员可以根据情况协商,将页面文件及图片与程序独立存放在各自的服务器上,页面改版和修改程序独立进行。 (3)使用include技术将分割开的HTML页面分别嵌入程序代码中,要求做到修改HTML页面时无须改写程序,而修改程序时不会影响HTML页面效果,将页面改版和修改程序两项工作分别独立。 (4)页面和程序嵌套以后不能破坏原HTML页面的整体显示效果,字体、字号、颜色等应尽量保持原HTML页面的风格。 (5)动态生成的页面的各项指标(如图片大小、页面宽度、高度、页面文件的字节数等)应符合本公司网页设计方面的要求。 4、测试规范(软件部分) 对于较大的项目应成立相应的测试小组,小组成员由软件开发人员、网页设计人员、技术人员、

ISO软件开发全套文档~软件开发过程控制程序

北京易游无限科技公司 https://www.360docs.net/doc/9f12417098.html, EUWX/QP 0714 软件开发过程控制控制程序 授控状态: 版号:A/O 分发号: 持有人: 2007年8月6日发布2007年8月6日实施

易游无限科技发布 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第1页

为保证软件产品及其文档可维护,软件开发过程得到有效控制,特制定本程序。 2适用范围 本程序文件适用于本公司有合同的所有软件开发过程的控制活动。 3定义 3.1需求分析:(引用GB/T11457-1995的2.404)研究用户要求以得到系统或软件需求定义的过程。 3.2概要设计:(引用GB/T11457-1995的2.343)分析各种设计方案和定义软件体系结构的过程。典型的概要设计包括计算机程序组成成分和数据的定义及构造、界面的定义,并提出时间和规模方面的估计。 3.3详细设计:(引用GB/T11457-1995的2.147)推敲并扩充概要设计,以获得关于处理逻辑、数据结构和数据定义的更加详尽的描述,直到设计完善到足以能实现的地步。 3.4设计实现:(引用GB/T11457-1995的2.229)把设计翻译成代码,然后对此代码排除隐错的过程。它是程序的一种机器可执行形式,或者能被自动地翻译成机器可执行的形式的某种形式的程序。 4职责 4.1项目负责人:负责制订《项目计划》、协调项目内外各方的关系、控制项目进度并保证项目计划的实施和完成。 4.2需求分析员:作为开发方的代表,负责沟通用户和开发人员的认识和见解,明确及准确地编写《软件需求说明书》和初步的《系统指南》。 4.3系统设计员:负责把软件需求变换成可表示的可实现的软件形式,为设计实现提供可行的依据。并在设计过程中要负责编写《概要设计说明书》、《数据库设计说明书》、《详细设计说明书》,完成《系统指南》的编写。 4.4程序员:按设计要求把软件的详细设计变换成可执行的源程序,进行调试。完成相应的文档,编写《用户操作手册》。 4.5测试人员:负责制定测试计划,设计测试方案,测试用例,并实施测试。 4.6配置管理人员负责对开发库中软件配置项的管理和维护。 4工作程序 软件开发过程主要分为项目计划、需求分析、概要设计、详细设计、设计实现、内部测试和系统测试7个阶段。 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第2页

软件项目开发计划规范

软件项目开发计划规范 1 引言 1.1编写目的 ? 阐明开发本软件的目的; ? 说明编写这份项目开发计划的目的; ? 指明软件需求说明书所预期的读者。 1.2背景 ? 表示待开发的软件系统的名称、代码; ? 列出本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络; ? C.说明该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出用得着的参考资料,如: a.本项目的经核准的计划任务书或合同、上级机关的批文; b.属于本项目的其他已发表的文件; c.本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2 项目概述 2.1 工作内容 简要地说明在本项目的开发中须进行的各项主要工作。 2.2主要参加人员 扼要说明参加本项目开发工作的主要人员的情况,包括他们的技术水平。 2.3产品 2.3.1程序 列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式,并通过引用有关文件,逐项说明其功能和能力。 2.3.2文件 列出需移交给用户的每种文件的名称及内容要点。 2.3.3服务 列出需向用户提供的各项服务,如培训安装、维护和运行支持等,应逐项规定开始日期、所提供支持的级别和服务的期限。 2.3.4非移交的产品 说明开发集体应向本单位交出但不必向用户移交的产品(文件甚至某些程序)。 2.4验收标准 对于上述这些应交出的产品和服务,逐项说明或引用资料说明验收标准。 2.5完成项目的员迟用限 2.6本计划的批准者和批准日期 3实施计划 3.1工作任务的分门与人员分工

一个完整的软件开发流程

一个完整的软件开发流程 一、开发流程图 二、过程产物及要求 本表主要列出开发阶段需要输出的过程产物,包括产物名称、成果描述、负责人及备注,即谁、在什么时间、应该提供什么内容、提供内容的基本方向和形式是什么。 三、过程说明 (一)项目启动 1、产品经理和项目干系人确定项目方向,产品型项目的干系人包括公司领导、产品总监、技术总监等,项目的话则包括客户方领导、主要执行人等。

2、公司领导确认项目组团队组成,包括产品经理、研发项目经理、研发工程师、测试团队等。 3、明确项目管理制度,每个阶段的成果产物需要进行相应的评审,评审有相应的《会议纪要》;从项目启动起,研发项目经理每周提供《项目研发周报》;测试阶段,测试工程师每周提供《项目测试周报》。 4、产品经理进行需求调研,输出《需求调研》文档。需求调研的方式主要有背景资料调查和访谈。 5、产品经理完成《业务梳理》。首先,明确每个项目的目标;其次,梳理项目涉及的角色;再来,每个角色要进行的事项;最后,再梳理整个系统分哪些端口,要有哪些业务模块,每个模块再包含哪些功能。 (二)需求阶段 1、进入可视化产物的输出阶段,产品经理提供最简单也最接近成品的《产品原型》,线框图形式即可。在这个过程中还可能产生的包括业务流程图和页面跳转流程图。业务流程图侧重在不同节点不同角色所进行的操作,页面跳转流程图主要指不同界面间的跳转关系。项目管理者联盟 2、产品经理面向整个团队,进行需求的讲解。 3、研发项目经理根据需求及项目要求,明确《项目里程碑》。根据项目里程表,完成《产品开发计划》,明确详细阶段的时间点,最后根据开发计划,进行《项目任务分解》,完成项目的分工。 4、研发工程师按照各自的分工,进入概要需求阶段。《概要需求》旨在让研发工程师初步理解业务,评估技术可行性。 (三)设计阶段 1、UI设计师根据产品的原型,输出《界面效果图》,并提供界面的标注,最后根据主要的界面,提供一套《UI设计规范》。UI设计规范主要是明确常用界面形式尺寸等,方便研发快速开发。UI设计常涵盖交互的内容。 2、研发工程师在界面效果图,输出《需求规格》,需求规格应包含最终要实现的内容的一切要素。 3、研发工程师完成《概要设计》、《通讯协议》及《表结构设计》,及完成正式编码前的一系列研发设计工作。 (四)开发阶段项目经理博客 1、研发工程师正式进入编码阶段,这个过程虽然大部分时间用来写代码,但是可能还需要进行技术预研、进行需求确认。

ISO软件开发全套文档-配置管理计划编写指南

产品/项目系统名称 配置管理计划 北京XXXX有限公司 200 年××月 1引言 1.1编写目的

编写的目的主要在于对所开发的软件系统规定各种必要的配置管理条款,以保证所开发出的软件能满足用户需求。 1.2背景 a.开发的软件系统的名称 列出本软件系统的中文全称、英文全称及英文表示简称。 b.开发的软件系统的最终用户或适用的领域; c.项目来源、主管部门等 1.3定义 列出本文件中涉及的专门术语定义和外文缩写的原词组。 1.4参考资料 列出涉及的参考资料。 2 管理 描述软件配置管理的机构、任务、职责和有关的接口控制。 2.1 机构 描述软件生存周期中各阶段中软件配置管理的功能和负责软件配置管理的机构。 说明项目和自项目与其他有关项目之间的关系。 指出在软件生存周期各阶段中的软件开发或维护机构与配置控制组的关系。 2.2 任务 描述在软件生存周期中各阶段的配置管理任务以及要进行的评审和检查工作,并指出各阶段的阶段产品应存放在哪一类软件库中(软件开发库、软件受控制库或软件产品库)。 2.3 职责 指出负责各项软件配置管理任务(如配置标识、配置控制、配置状态记录以及配置的评审与检查)的机构的职责; 指出上述机构与软件质量保证机构、软件开发单位、项目承办单位、项目委托单位以及用户等机构的关系。 说明软件生存周期各个阶段的评审、检查和审批过程中的用户职责以及相关的开发与维护活动。 指出与项目开发有关的各机构的代表的软件配置管理职责。 指出与其他特殊职责,例如为满足软件配置管理要求所必要的批准要求。 2.4 定义软件配置项(SCI) 包括: 1.系统约定 2.软件项目计划 3.软件需求文档 4.用户手册 5.设计文档

软件开发技术文档编写规范

软件开发技术文档编写规范 在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。 ◇项目开发计划:为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书(软件规格说明书):对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。 ◇概要设计说明书:该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。 ◇详细设计说明书:着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。 ◇用户操作手册:本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。 ◇测试计划:为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告:测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。 ◇开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。 ◇软件维护手册:主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。 ◇软件问题报告:指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。 ◇软件修改报告:软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。 1可行性分析报告 1 引言 1.1 编写目的:阐明编写可行性研究报告的目的,提出读者对象。

软件开发过程规范

【最新资料,Word版,可自由编辑!】

目录 1.前言............................................................................................................................................... 1.1目的.......................................................................................................................................... 1.2对象.......................................................................................................................................... 1.3要求.......................................................................................................................................... 1.4适用范围.................................................................................................................................. 1.5软件开发过程模型................................................................................................................. 1.6开发过程划分 ......................................................................................................................... 2.技术过程规范部分...................................................................................................................... 2.1概述.......................................................................................................................................... 2.2业务建模阶段 ......................................................................................................................... 2.3需求阶段.................................................................................................................................. 2.4分析设计阶段 ......................................................................................................................... 2.5实现阶段.................................................................................................................................. 3.管理过程规范部分...................................................................................................................... 3.1概述.......................................................................................................................................... 3.2接受项目.................................................................................................................................. 3.3重新评估项目范围和风险(对于较大项目) ................................................................... 3.4制定开发计划 ......................................................................................................................... 3.5迭代开发管理 ......................................................................................................................... 3.6监控项目的实施 ..................................................................................................................... 3.7结束项目..................................................................................................................................

软件文档编写指南

《计算机软件文档编写指南》 一.计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式: 密级:编号: 文档名称: 项目名称: 编制: 审核: 批准: ×××××××××××××研究所 年月日

二.计算机软件文档包括: 1)软件开发计划 2)软件需求规格说明 3)接口需求规格说明 4)接口设计文档 5)软件设计文档 6)软件产品规格说明 7)版本说明文档 8)软件测试计划 9)软件测试说明 10)软件测试报告 11)计算机系统操作员手册 12)软件用户手册 13)软件程序员手册 14)计算机资源综合保障文件 软件开发计划 一.引言 1.编写目的(阐明编写软件计划的目的,指出读者对象。) 2.项目背景(可包括:(1)项目委托单位、开发单位和主管部门;(2)该软件系统与其他系统的关系。) 3.定义(列出本文档中用到的专门术语的定义和缩略词的原文。) 4.参考资料(可包括:(1)项目经核准的计划任务书、合同或上级机关的批文;(2)文档所引用的资料、规范等;列出资料的作者、标题、编号、发表日期、出版单位或资料来源。)二.项目概述 1.工作内容(简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性 研究报告,则应在本节给出较详细的介绍。) 2.条件与限制(阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。) 3.产品 (1)程序(列出应交付的程序名称使用的语言及存储形式。) (2)文档(列出应交付的文档。) (3)运行环境(应包括硬件环境软件环境。) 4.服务(阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。)

软件开发文档样式规范

文档编号:_________ _________ 文档名称:____________ 项目名称:____________ 项目负责人:____________ 编写:___________ ____年__月__日

校对:___________ ____年__月__日审核:___________ ____年__月__日批准:___________ ____年__月__日 开发单位:广东传讯网络信息有限公司________________________ 系统规格说明

一、系统功能和目标: 随着因特网的不断普及,国内的用户数呈指数级增长。作为因特网最为常用的电子邮件系统越来越受到人们的喜爱,为了满足不断增长的信息交换的需要,各行各业都希望有自己的邮件系统。广东传讯网络信息有限公司自主设计开发了适合中国国情的免费电子邮件系统,用以解决这一日益突出的问题。CHINATION免费电子邮件系统是专为免费电子邮件服务商、企业集团设计的电子邮件系统。 Chination免费电子邮件系统的设计目标是立足于一个高度集成的、功能强大、技术先进的电子邮件系统。高度集成意味着本系统将把硬盘软件集成在一起。系统是基于LINUX下的,硬盘和软件的集成使得系统具有绝对的安装优势。功能强大意味着系统的实用性,功能的全面性,系统的安全性和可靠性。技术先进意味着将最新版本的LDAP,IMAP,POSTFIX,MYSQL,APACHE 和PHP的巧妙结合。 本系统要实现的主要功能有: 1.用户申请注册功能。用户通过申请可以得到一个自己命名的信箱,容量大小为10M。 2.用户忘记密码处理功能。用户忘记密码可以通过注册时设置的密码提示问题来重设密码。 3.用户收邮件功能。它包括SMTP收邮件、POP3取邮件和WWW读邮件三种方式。 4.用户发邮件功能。它包括SMTP发邮件、WWW直接发送邮件、暗送邮件、抄送邮件、定时发送邮件。 5.用户信件处理功能。系统初始设置4个文件夹来分类处理信件:收件箱、发件箱、草稿箱和垃圾箱。用户还可以自己建立新的文件夹。信件在各个信箱之间可以相互移动。 6.用户查找功能。用户可以使用查找功能通过查找信件主题或信件内容来找到自己需要的信件。 7.用户信箱配置设置。它包括个人资料更改、密码更改、参数设置、POP3服务器设置、过滤器设置、自动转信、定时发信、签名设置。 8.管理员管理用户和信箱邮件功能。包括输入(增删改)、查询、统计、报表。系统性能参数设置。 9.广播功能。它用于公司定期向一定的用户发送信息,由于一般的用户数有一定数量,所以必须用数据库管。 二、可行性分析 1.技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面,由于广东传讯网络信息有限公司是国外多

软件开发实施方案

1软件开发实施方案 系统开发严格按照软件工程的方法进行组织,系统的开发过程按照需求分析、系统分析与设计要求、系统编码、系统测试几个过程有序推进。下表所示系统开发流程图,采用原型及迭代方式开发,根据用户需求持续改进,直到最终用户确认满意。 1.1开发流程总述 如下图示流程定义了我公司内部的软件开发过程,以指导和规范软件项目中开发过程的定义和相应的实施。 该过程可划分为一系列子过程,包括:软件需求分析、设计、编码、测试、验收、维护,每个子过程又由一系列任务和活动组成,如设计过程又可分为结构设计和详细设计。但是在实际开发项目中,情况仍然会是千变万化的,因此我们也并不是一成不变的死板执行一个僵化的工作流程,我们的原则是在一个规范流程的指导和约束下,根据具体工程项目的实际要求,为每一个项目评估并制定真正能够最好的满足该项目要求的开发流程。

图 1.1-1 软件开发流程总图

在应用系统软件开发项目中,我们仍将遵循这一思想,这一点将在随后的项目开发实施计划部分有具体的体现,在这里和下面的相关章节中,我们仍将围绕着这个完整的开发流程来分析说明,以此来阐明我们对项目开发的完整过程管理思想和相关实践。下面我们对这个软件开发工作流程进行简要地分解说明。 1.2 软件需求分析 (1)概述 由于应用系统与众多相关应用软件需要进行交互,因此需要先对这些应用系统进行分别梳理,充分做好需求调研工作,编写经项目单位认可并评审通过的《系统需求规格说明书》。 软件需求分析是按照项目定义的软件开发过程,根据系统分配给软件的需求(见《系统需求规格说明书》),进行软件质量特性规格说明的过程。该过程包括进一步明确软件运行环境,明确对软件的功能、性能和数据要求,以及软件与硬件、软件与软件之间的接口要求等,并对软件需求进行验证和文档化,即完成对软件需求的分析与规格定义。 本元素在整个过程中的位置如下图所示: 图示:软件需求分析在软件开发过程中的位置 (2)入口准则和出口准则 软件需求分析 结构设计 系统分配给软 件的需求

GB 16680-1996 软件文档管理指南

GB/16680-1996软件文档管理指南 1 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划,管理者必须关注这些内容,以便有效地管理软件文档。 本标准期望应用于各种类型的软件,从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档,作用于软件生存期的各个阶段。 不论项目的大小,软件文档管理的原则是一致的。对于小项目,可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的,不涉及软件文档的内容和编排。 2 引用标准 下列标准所包含的条文,通过在本标准中引用而构成为本标准的条文。本标准出版时,所示版本均为有效,所有标准都会被修订,使用本标准的各方应探讨使用下列标准最新版本的可能性。 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 3 定义 本标准采用下列定义,其他定义见 GB/T 11457 。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如,技术文件、设计文件、版本说明文件。 3.2 文档(集);文档编制 documentation 一个或多个相关文档的集合。 3.3 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档,这些文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外界因素。 3.4 文档等级 level of documentation 对所需文档的一个说明,它指出文档的范围、内容、格式及质量,可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 3.5 软件产品 software product 软件开发过程的结果,并推出供用户使用的软件实体。 4 软件文档的作用 a) 管理依据; b) 任务之间联系的凭证; c) 质量保证; d) 培训与参考; e) 软件维护支持; f) 历史档案。 4.1 管理依据 在软件开过过程中,管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的

相关文档
最新文档