项目开发设计说明(开发必备)

项目开发设计说明

在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。

◇ 可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

◇

◇ 成协议的条件下编写的，也是实施开发工作的基础。要求，为生成和维护系统数据文件做好准备。

◇ 划分、程序的总体结构、等，为详细设计提供基础。

◇ 详细设计说明书：逻辑流程等。 ◇ 该软件得到具体的了解, 的具体细节。

◇ ◇

◇ 阶段成果、遇到的问题和解决的办法以及下个月的打算等。

◇ 行的情况，成本和投入的人力，此外，还需对开发工作做出评价，

◇

◇ 软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

◇ 软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。

可行性分析报告

1 引言

1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。

1.2 项目背景：应包括

● 所建议开发软件的名称

● 项目的任务提出者、开发者、用户及实现软件的单位

● 项目与其他软件或其他系统的关系。

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

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

● 项目经核准的计划任务书、合同或上级机关的批文 ● 与项目有关的已发表的资料

●

2 可行性研究的前提

2.1

● 功能

● 性能

● 输入/输出

●

● 安全与保密要求

● ● 完成日期

2.2 目标：可包括

●

●

●

●

2.3 ●

●

●

● 法律和政策方面的限制

● 硬件、软件、运行环境和开发环境的条件和限制

● 可利用的信息和资源

● 建议开发软件投入使用的最迟时间

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.5 技术可行性评价:包括

● 在限制条件下，功能目的是否达到

● 利用现有技术，功能目的是否达到

● ● 5 所建议系统经济可行性分析

5.1 支出

5.2 效益

5.3 收益/投资比

5.4 投资回收周期

5.5

●

●

6 6.1

●

● ● 6.2

● 用户单位的行政管理

● 工作制度

● 人员素质等能否满足要求

7 其他可供选择的方案

逐个阐明其它可供选择的方案，并重点说明未被推荐的理由。

8 结论意见

● 可着手组织开发

● 需等待若干条件具备后才能开发

● 需对开发目标进行某些修改

● 不能进行或不必进行及其他

项目开发计划

1 引言

1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象

1.2 项目背景：应包括

● 项目的委托单位、开发单位和主管部门；

● 该软件系统与其他系统的关系。

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

1.4 参考资料：可包括：

● ● 文档所引用的资料、规范等

● 2 项目概述

2.1 工作内容:

● 等；● 若不编写可行性研究报告；

● 2.2 条件与限制:

● ●

2.3 产品

2.3.1

2.3.2

2.4

如人员培训、安装、保修、维护和其他运行支持。

2.6 3 实施计划

3.1

3.2

3.3 预算

3.4 关键问题：如设备条件、技术难点或其他风险因素，并说明对策。

4 人员组织及分工

5 交付期限

6 专题计划要点

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

软件需求说明书

1 引言

1.1 编写目的：阐明编写需求说明书的目的，指明读者对象。

1.2 项目背景：应包括

● 项目的委托单位、开心单位和主管部门；

● 该软件系统与其他系统的关系。

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

1.4 参考资料：可包括

● 项目经核准的计划任务书、合同或上级机关的批文

● 文档所引用的资料、规范等

●

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.2

5.3 6 运行需求

6.1

6.2

6.3 软件接口

6.4 故障处理

其他需求

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

概要设计说明书

1 引言

1.1 写目的：阐明编写概要设计说明书的目的，指明读者对象。

1.2 项目背景：应包括

● 项目的委托单位、开发单位和主管部门

● 该软件系统与其他系统的关系

1.3 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。

1.4 参考资料：

● 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源

●明书；测试计划（初稿）；用户操作手册

● 文档所引用的资料、采用的标准或规范。

2 任务概述

2.1 目标

2.2 需求概述

2.3 条件与限制

3 总体设计

3.2 总体结构和模块外部设计

3.3 4 接口设计

4.1

4.2

5 数据结构设计

6 逻辑结构设计

7 物理结构设计

8 9 9.1

9.2

9.3 运行时间10 出错处理设计 10.1 10.2

11 安全保密设计

12 维护设计

说明为方便维护工作的设施，如维护模块等。

详细设计说明书

1 引言

1.1 编写目的：阐明编写详细设计说明书的目的，指明读者对象。

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

1.3 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。

1.4 参考资料：

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

●明书；概要设计说明书；测试计划（初稿）；用户操作手册

● 文档所引用的资料、软件开发的标准或规范。

2 总体设计

2.1 需求概述

2.2 软件结构：如给出软件系统的结构图。

3 程序描述

3.1 逐个模块给出以下说明：

● 功能

● 性能

● 输入项目

● 输出项目

3.2

3.3 PDL 语言；N-S 图；

3.4 接口

●

3.5

用户操作手册

1 引言

1.1 编写目的：阐明编写手册的目的，指明读者对象。

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

1.3 定义：列出手册中使用的专门术语的定义和缩写词的愿意。

1.4 参考资料：

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

● 说明书；概要设计说明书；详细设计说明书；测试计划

●

2 软件概述

2.1 目标

2.2 功能

2.3 性能

2.4 2.5 2.6

3 运行环境

3.1 硬件

●

● ●

●

3.2

●

● 4 使用说明

4.1

4.2

● 数据背景：说明数据来源、存储媒体、出现频度、限制和质量管理等。

● 数据格式:如长度、格式基准、标号、顺序、分隔符、词汇表、省略和重复、控制。

● 输入举例。

4.3 输出：给出每项输出数据的说明。

● 数据背景：说明输出数据的去向、使用频度、存放媒体及质量管理等。

● 数据格式：详细阐明每一输出数据的格式，如首部、主体和尾部的具体形式。 ● 举例

4.4 出错和恢复：给出出错信息及其含意；用户应采取的措施，如修改、恢复、再启

4.5 求助查询：说明如何操作。

5 运行说明

5.1 运行表：列出每种可能的运行情况，说明其运行目的。

5.2 运行步骤：按顺序说明每和运行的步骤，应包括：

5.3 运行控制

5.4 操作信息：运行目的、运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项；

5.5输入/输出文件：给出建立或更新文件的有关信息，如：文件的名称及编号；记录媒体；存留的目录；文件的支配：说明确定保留文件或废弃文件的准则，分发文件的对象，战胜硬件的优先级及保密控制等。

5.6 启动或恢复过程

6 非常规过程

提供应急戒非常规操作的必要信息及操作步骤，及维护人员须知的操作和注意事项。

7 操作命令一览表

8 程序文件（或命令文件）和数据文件一览表

9 用户操作举例

测试计划

1 引言

1.1 编写目的：阐明编写测试计划的目的并指明读者对象。

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

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

1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；本测试计划中引用的其他资料、采用

的软件开发标准或规范。

2 任务概述

2.1 目标

2.2 运行环境

2.3 需求概述

2.4 条件与限制

3 计划

3.1 3.2

3.3 测试准备

3.4

4 测试项目说明

4.1

4.1.1

4.1.2 测试用例

4.1.3

4.1.4

4.2

4.4

4.5

4.6

5 评价

5.1

5.2

测试分析报告

1 引言

1.1 编写目的：阐明编写测试分析报告的目的并指明读者对象。

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

1.3定义：列出测试分析报告中所用到的专门术语的定义和缩写词的原意。

1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；测试计划；测试分析报告所引用的其他资料、采用的软件工程标准或工程规范。

2 测试计划招待情况

2.1 机构和人员：给出测试机构名称、负责人和参与测试人员名单。

2.2 该项测试表明的事实；该项测试发现的问题。

3 软件需求测试结论

按顺序给出每一项需求测试的结论。包括：充分测试的情况及原因。

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参 考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设 计说明书；详细设计说明书；用户操作手册；测试计划；测试分析报告；本报告引用的其他资料、采用的开发标准或开发规范。

2 开发结果

2.1 程序总计数量、存储形式；产品文档名称等。

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

2 系统说明

2.1

2.2

2.3 总体说明：说明系统的总体功能，对系统、子系统和作业做出综合性的介绍，并用图表的方式给出系统主要部分的内部关系。

2.4 程序说明：说明系统中每一程序、分程序的细节和特性。

2.4.1 程序1的说明

● 功能：说明程序的功能。

● 方法：说明实现方法。

● 输入：说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。

● 处理：处理特点和目的，如：用图表说明程序的运行的逻辑流程；程序主要转移条件；对程序的约束条件；程序结束时的出口要求；与下一个程序的通信与联结（运行、控制）；由该程序产生并茶馆处理程序段使用的输出数据类型和存放单元；程序运行存储量、类型及存储位置等。

● 输出：程序的输出。

● 接口：本程序与本系统其他部分的接口。

●表 格：说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括：表的标识符；使用目的；使用此表的其他程序；逻辑划分，如块或部，不包括表项；表的 基本结构；设计安排，包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示

●

2.4.2程序2的说明

与程序1的说明相同。以后的其他各程序的说明相同。

3 操作环境

3.1 设备：逐项说明系统的设备配置及其特性。

3.2

3.3 3.3.1存储媒体；程序使用数据库的限制。

●

●

● 字段的字符长度和位数、该字段的允许值范围。

● 4 维护过程

4.1 卡片的连接顺序、语句和记标准化的数据元素及其特征。

4.2 对其进行验证的要求和过程（包括测试程序和数据）

4.3

4.4 如：维护该软件系统的输程和验证方法；对闰年、世纪变更的所需要的临时性修改等。

4.5 专用维护程序：列出维护软件系统使用的后备技术和专用程序（如文件恢复程序、淘汰过时文件的程序等）的目录，并加以说明，内容包括：维护作业的输入输出要求；输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。

4.6 程序清单和流程图：引用或提供附录给出程序清单和流程图。

软件问题报告

1 登记号

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

2 登记日期

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

3 问题发现日期

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

4 活动

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

5 状态

在软件配置记录中维护的动态指示，状态表示有：正在复查" 软件问题报告" ，以确定将采取什么行动；" 软件问题报告" 已由指定的人去进行处理；修改已完 成，并经过测试，正准备交给主程序库；主程序库已经更新，主程序库修改的重新测试沿未完成；做了重新测试，问题再现；做了重新测试，所做的修改无故障，" " 被关闭；留待以后关闭。

6 报告人

填写" 软件问题报告" 人员的姓名、地址、电话。

7 问题属于什么方面

区分是程序的问题，还是模块的问题，的某种组合。

8 模块/子系统

9 修订版本号

出现问题的模块版本。

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 资源

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