软件设计文档国家标准GB8567

软件设计文档国家标准GB８５６７-88

一、文档编写标准化

在整个项目开发及使用过程中,应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。一般要求编写好十三种文档。

1、可行性分析报告

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

2、项目开发计划

为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书(软件规格说明书）

对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。

4、概要设计说明书

是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书

着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

6、用户操作手册

详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。

７、测试计划

包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。8、测试分析报告

测试计划的执行情况,对测试结果的分析,提出测试结论。

9、开发进度月报

按月提交的项目进展情况报告。包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

１0、项目开发总结报告

项目完成以后，总结实际执行情况。如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

11、软件维护手册

主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。12、软件问题报告

记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。13、软件修改报告

软件产品投入使用后,发现了需修改、更正的问题,要将出现的问题、修改意见、修改可能出现影响作出详细描述,提交审批。

二、可行性分析报告的撰写要求

可行性研究报告的编写内容要求如下：

1引言

1.１编写目的

说明编写本可行性研究报告的目的,指出预期的读者。

1.２背景

说明:

a.所建议开发的软件系统的名称；

b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；

C．该软件系统同其他系统或其他机构的基本的相互来往关系。

1.3定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1.4参考资料

列出用得着的参考资料,如:

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

b.属于本项目的其他已发表的文件；

Ｃ.本文件中各处引用的文件、资料，包括所需用到的软件开发标准。｜

列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。

2可行性研究的前提

说明对所建议的开发项目进行可行性研究的前提，如要求、目标、假定、限制等。

２．1要求

说明对所建议开发的软件的基本要求,如：

a．功能;

b．性能；

C．输出如报告、文件或数据,对每项输出要说明其特征，如用途、产生频度、接口以及分发对象;

ｄ．输入说明系统的输入,包括数据的来源、类型、数量、数据的组织以及提供的频度;

e.处理流程和数据流程用图表的方式表示出最基本的数据流程和处理流程，并辅之以叙述；ｆ.在安全与保密方面的要求；

ｇ．同本系统相连接的其他系统;

h.完成期限。

２．2目标

说明所建议系统的主要开发目标，如:

a．人力与设备费用的减少；

b．处理速度的提高;

C.控制精度或生产能力的提高；

ｄ.管理信息服务的改进；

e.自动决策系统的改进;

f.人员利用率的改进。

2．3条件、假定和限制

说明对这项开发中给出的条件、假定和所受到的限制,如：

a.所建议系统的运行寿命的最小值;

b．进行系统方案选择比较的时间；

c.经费、投资方面的来源和限制;

d．法律和政策方面的限制；

ｅ．硬件、软件、运行环境和开发环境方面的条件和限制；

f．可利用的信息和资源；

g.系统投入使用的最晚时间。

2．4进行可行性研究的方法

说明这项可行性研究将是如何进行的,所建议的系统将是如何评价的。摘要说明所使用的基本方法和策略,如调查、加权、确定模型、建立基准点或仿真等。

２．5评价尺度

说明对系统进行评价时所使用的主要尺度,如费用的多少、各项功能的优先次序、开发时间的长短及使用中的难易程度。

３对现有系统的分析

这里的现有系统是指当前实际使用的系统,这个系统可能是计算机系统,也可能是一个机械系统甚至是一个人工系统。

分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。３.1处理流程和数据流程

说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表示,并加以叙述。

3．２工作负荷

列出现有系统所承担的工作及工作量。

3．３费用开支

列出由于运行现有系统所引起的费用开支,如人力、设备、空间、支持性服务、材料等项开支以及开支总额。

3．4人员

列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。

3.5设备

列出现有系统所使用的各种设备。

3．6局限性

列出本系统的主要的局限性,例如处理时间赶不上需要,响应不及时,数据存储能力不足，处理功能不够等。并且要说明,为什么对现有系统的改进性维护已经不能解决问题。

4 所建议的系统

本章将用来说明所建议系统的目标和要求将如何被满足。

4．1对所建议系统的说明

概括地说明所建议系统，并说明在第1．２章中列出的那些要求将如何得到满足,说明所使用的基本方法及理论根据。

4.2处理流程和数据流程

给出所建议系统的处理流程和数据流程。

4．３改进之处

按2.２条中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。

4．4影响

说明在建立所建议系统时,预期将带来的影响，包括：

4.４.1对设备的影响

说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。

４．4．２对软件的影响

说明为了使现存的应用软件和支持软件能够同所建议系统相适应。而需要对这些软件所进行的修改和补充。

4．4．3对用户单位机构的影响

说明为了建立和运行所建议系统，对用户单位机构、人员的数量和技术水平等方面的全部要求。

4.4.4对系统运行过程的影响

说明所建议系统对运行过程的影响，如：

a.用户的操作规程;

b．运行中心的操作规程；

C．运行中心与用户之间的关系；

d.源数据的处理;

e．数据进入系统的过程;

f.对数据保存的要求，对数据存储、恢复的处理;

ｇ.输出报告的处理过程、存储媒体和调度方法;

h.系统失效的后果及恢复的处理办法。

４.4.5对开发的影响

说明对开发的影响,如:

a.为了支持所建议系统的开发,用户需进行的工作；

b.为了建立一个数据库所要求的数据资源；

C．为了开发和测验所建议系统而需要的计算机资源；

d．所涉及的保密与安全问题。

4.4．6对地点和设施的影响

说明对建筑物改造的要求及对环境设施的要求。

４.４.７对经费开支的影响

扼要说明为了所建议系统的开发，设计和维持运行而需要的各项经费开支。

4．５局限性

说明所建议系统尚存在的局限性以．及这些问题未能消除的原因。

４.６技术条件方面的可行性

本节应说明技术条件方面的可行性,如:

a.在当前的限制条件下,该系统的功能目标能否达到；

ｂ.利用现有的技术,该系统的功能能否实现;

C．对开发人员的数量和质量的要求并说明这些要求能否满足;

ｄ．在规定的期限内，本系统的开发能否完成。

５可选择的其他系统方案

扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑,则说明这一点。

５.1可选择的系统方案1

参照第4章的提纲，说明可选择的系统方案1，并说明它未被选中的理由。

5．2可选择的系统方案2

按类似５．１条的方式说明第2个乃至第。个可选择的系统方案。

．.．.．.

６投资及效益分析

6．1支出

对于所选择的方案，说明所需的费用。如果已有一个现存系统,则包括该系统继续运行期间所需的费用。

６.1.1基本建设投资

包括采购、开发和安装下列各项所需的费用,如：

a．房屋和设施;

ｂ.A DP设备;

C．数据通讯设备;

ｄ．环境保护设备；

e．安全与保密设备;

f.AＤP操作系统的和应用的软件;

ｇ.数据库管理软件。

６.1.2其他一次性支出

包括下列各项所需的费用,如:

a．研究(需求的研究和设计的研究)；

b.开发计划与测量基准的研究；

Ｃ.数据库的建立;

ｄ．ＡDP软件的转换；

e．检查费用和技术管理性费用；

f.培训费、旅差费以及开发安装人员所需要的一次性支出；

g．人员的退休及调动费用等。

6．1．3非一次性支出

列出在该系统生命期内按月或按季或按年支出的用于运行和维护的费用,包括：

a.设备的租金和维护费用；

b软件的租金和维护费用；

Ｃ．数据通讯方面的租金和维护费用；

d．人员的工资、奖金;

ｅ.房屋、空间的使用开支;

f．公用设施方面的开支；

ｇ．保密安全方面的开支；

h.其他经常性的支出等。

6．2收益

对于所选择的方案，说明能够带来的收益,这里所说的收益，表现为开支费用的减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等,包括;

6．2．1一次性收益

说明能够用人民币数目表示的一次性收益,可按数据处理、用户、管理和支持等项分类叙述,如：

ａ．开支的缩减包括改进了的系统的运行所引起的开支缩减，如资源要求的减少，运行效率的改进,数据进入、存贮和恢复技术的改进，系统性能的可监控,软件的转换和优化，数据压缩技术的采用,处理的集中化/分布化等；

b．价值的增升包括由于一个应用系统的使用价值的增升所引起的收益，如资源利用的改进,管理和运行效率的改进以及出错率的减少等;

C．其他如从多余设备出售回收的收入等。

６．２．2非一次性收益

说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益，包括开支的减少和避免。

６.2.3不可定量的收益

逐项列出无法直接用人民币表示的收益,如服务的改进,由操作失误引起的风险的减少，信息掌握情况的改进,组织机构给外界形象的改善等。有些不可捉摸的收益只能大概估计或进行极值估计(按最好和最差情况估计）。

6.3收益/投资比

求出整个系统生命期的收益/投资比值。

6．4投资回收周期

求出收益的累计数开始超过支出的累计数的时间。

６.5敏感性分析

所谓敏感性分析是指一些关键性因素如系统生命期长度、系统的工作负荷量、工作负荷的类型与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时,对开支和收益的影响最灵敏的范围的估计。在敏感性分析的基础上做出的选择当然会比单一选择的结果要好一些。

7社会因素方面的可行性

本章用来说明对社会因素方面的可行性分析的结果，包括：

７．1法律方面的可行性

法律方面的可行性问题很多，如合同责任、侵犯专利权、侵犯版权等方面的陷井，软件人员通常是不熟悉的,有可能陷入，务必要注意研究。

7.2使用方面的可行性

例如从用户单位的行政管理、工作制度等方面来看，是否能够使用该软件系统；从用户单位的工作人员的素质来看，是否能满足使用该软件系统的要求等等,都是要考虑的。

8 结论

在进行可行性研究报告的编制时，必须有一个研究的结论。结论可以是：

a.可以立即开始进行;

b．需要推迟到某些条件（例如资金、人力、设备等)落实之后才能开始进行；

ｃ.需要对开发目标进行某些修改之后才能开始进行；

d.不能进行或不必进行（例如因技术不成熟、经济上不合算等)

三、项目开发计划

1 引言

1.１编写目的

说明编写这份项目开发计划的目的,并指出预期的读者。

1.2 背景

说明:

a.待开发的软件系统的名称；

b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络;

C.该软件系统同其他系统或其他机构的基本的相互来往关系。1．3 定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料

列出用得着的参考资料，如：

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

b. 属于本项目的其他已发表的文件；

Ｃ.本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

２项目概述

２.1工作内容

简要地说明在本项目的开发中须进行的各项主要工作。

2.2主要参加人员

扼要说明参加本项目开发工作的主要人员的情况,包括他们的技术水平。

2.３产品

2.3．1 程序

列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式,并通过引用有关文件，逐项说明其功能和能力。

2.3.2 文件

列出需移交给用户的每种文件的名称及内容要点。

２．3．3服务

列出需向用户提供的各项服务,如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持的级别和服务的期限。

2.3．4 非移交的产品

说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序)。

2．4验收标准

对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。

2.5 完成项目的期限

２.6 本计划的批准者和批准日期

3实施计划

３．1 工作任务的分门与人员分工

对于项目开发中需完成的各项工作,从需求分析、设计、实现、测试直到维护，包括文件的编制、审批、打印、分发工作,用户培训工作,软件安装工作等，按层次进行分解，指明每项任务的负责人和参加人员。?3.２接口人员

说明负责接口工作的人员及他们的职责,包括:

a.负责本项目同用户的接口人员；

b.负责本项目同本单位各管理机构,如合同计划管理部门、财务部门、质量管理部门等的接口人员；

c.负责本项目同各分合同负责单位的接口人员等。

3.3 进度

对于需求分析、设计、编码实现、测试、移交、培训和安装等工作,给出每项工作任务的预定开始日期、完成日期及所需资源,规定各项工作任务完成的先后顺序以及表示每项工作任务完成的标志性事件（即所谓“里程碑”)。

３.4 预算

逐项列出本开发项目所需要的劳务（包括人员的数量和时间）以及经费的预算(包括办公费、差旅费、机时费、资料费、通讯设备和专用设备的租金等）和来源。

3.5 关键问题

逐项列出能够影响整个项目成败的关键问题、技术难点和风险,指出这些问题对项目的影响。

4 支持条件

说明为支持本项目的开发所需要的各种条件和设施。

４．１计算机系统支持

逐项列出开发中和运行时所需的计算机系统支持，包括计算机、外围设备、通讯设备、模拟器、编译（或汇编)程序、操作系统、数据管理程序包、数据存储能力和测试支持能力等,逐项给出有关到货日期、使用时间的要求。

4.2 需由用户承担的工作

逐项列出需要用户承担的工作和完成期限。包括需由用户提供的条件及提供时间。

4.3 由外单位提供的条件

逐项列出需要外单位分合同承包者承担的工作和完成的时间，包括需要由外单位提供的条件和提供的时间。

５专题计划要点

说明本项目开发中需制订的各个专题计划(如分合同计划、开发人员培训计划、测试计划、安全保密计划、质量保证计划、配置管理计划、用户培训计划、系统安装计划等）的要点。

软件架构设计文档

软件架构设计文档 Document serial number【UU89WT-UU98YT-UU8CB-UUUT-UUT108】

密级：内部公开 文档编号：1002 版本号： 测测（基于安卓平台的测评软件） 软件架构设计文档 计算机与通信工程学院天师团开发团队

修订历史记录 目录

1．文档介绍 文档目的 本文档是对于测测软件系统进行详细设计和编码的重要依据。对该软件的整个系统的结构关系进行了详细描述，阐述了系统的总体框架，包括物理、逻辑结构，说明了体系结构所采取的设计策略和所有技术，并对相关内容做出了统一的规定。为今后的设计、编码、测试都提供了可以参考的模版并且提高效率，使整个开发过程做到资源利用最大化，减少由于需求变更而修改的时间，大大的降低了成本，节约了时间，也使得客户更加的满意。 文档范围 本文档包含以下几个部分： 1、架构设计思想 2、架构体系描述 3、系统模块化分 4、系统模块描述 5、模块接口设计 读者对象 本文档主要读者包括：

1、本系统的设计人员：包括模块设计人员（理解用户需求，在设计时把握用户需求）。 2、本系统的系统开发人员：编码人员（了解用户需求，为编码提供模版）。 3、本系统的测试人员（了解用户需求，为测试提供参考）。 4、客户（检查是否满足要求）。 参考文献 《软件工程讲义》 《测测需求规格说明书》 2．架构设计思想 为了降低系统耦合度，增加系统内聚性，在需求发生更改时能在较短的时间内对系统做出修改，并重新投入使用，我们决定以分层体系架构风格作为整个系统的体系风格，严格按照一定的规则来进行接口设计，并以之为根据进行详细设计。分为数据层、业务逻辑层、表示层。 3．架构体系描述 整个系统顶层架构采用分层的风格，整个系统的体系结构非常清晰，使得后期易于详细设计、编码、维护以及适应需求变更。通过分层，定义出层与层之间的接口，使得在更加规范的同时拥有更为多台花的接口描述，使得层与层之间的耦合度降低，增强了模块的服用型和可

软件项目详细设计文档示例模版

XXX软件/项目/系统 详细设计说明书 拟制日期 评审人日期 批准日期 编写单位或个人

修订历史

目录 XXX软件详细设计说明书 (1) Revision Record 修订记录 (2) 1引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3参考资料 (1) 1.4术语定义及说明 (1) 2设计概述 (1) 2.1任务和目标 (1) 2.1.1需求概述 (1) 2.1.2运行环境概述 (1) 2.1.3条件与限制 (1) 2.1.4详细设计方法和工具 (1) 3系统详细需求分析 (1) 3.1详细需求分析 (2) 3.2详细系统运行环境及限制条件分析接口需求分析 (2) 4总体方案确认 (2) 4.1系统总体结构确认 (2) 4.2系统详细界面划分 (2) 4.2.1应用系统与支撑系统的详细界面划分 (2) 4.2.2系统内部详细界面划分 (2) 5系统详细设计 (2) 5.1系统结构设计及子系统划分 (3) 5.2系统功能模块详细设计 (3) 5.3系统界面详细设计 (3) 5.3.1外部界面设计 (3) 5.3.2内部界面设计 (3) 5.3.3用户界面设计 (3) 6、数据库系统设计 (4) 6.1设计要求 (4) 6.2 信息模型设计 (4) 6.3数据库设计 (4) 6.3.1设计依据 (4) 6.3.2数据库种类及特点 (4) 6.3.3数据库逻辑结构 (4) 6.3.4物理结构设计 (4) 6.3.5数据库安全 (4) 6.3.6数据字典 (4) 7非功能性设计 (4) 8 (5) 9环境配置 (5)

1引言 1.1编写目的 说明编制的目的是，大体上介绍一下软件系统中各层次中模块或子程序、以及数据库系统的设计考虑，表明此文档是主要是为编码人员提供服务，并且其他类型的项目参与人员也可以通过此文档对软件/项目有更深入了解。 1.2背景 说明此软件或系统的项目背景、需求背景、开发目的等，还可以列出参与人员等相关信息。 1.3参考资料 列出本文档中引用的文献、资料、标准等相关信息（一般是具有出版或版权性质的文件）。 1.4术语定义及说明 列出文档中用到的和开发有关，或与行业、业务、需求有关的专业术语，并进行解释。 2设计概述 2.1任务和目标 说明详细设计的任务及详细设计所要达到的目标。 2.1.1需求概述 对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。 2.1.2运行环境概述 对本系统所依赖于运行的硬件，包括操作系统、数据库系统、运行库、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。 2.1.3条件与限制 详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。 2.1.4详细设计方法和工具 简要说明详细设计所采用的方法和使用的工具，如数据库设计工具、界面设计工具、原型设计工具等。 3系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。

软件设计文档国家标准 概要设计说明书(GB8567——88)

1引言 (2) 1.1编写目的 (2) 1.2背景 (2) 1.3定义 (2) 1.4参考资料 (2) 2总体设计 (2) 2.1需求规定 (2) 2.2运行环境 (2) 2.3基本设计概念和处理流程 (3) 2.4结构 (3) 2.5功能器求与程序的关系 (3) 2.6人工处理过程 (3) 2.7尚未问决的问题 (3) 3接口设计 (3) 3.1用户接口 (3) 3.2外部接口 (3) 3.3内部接口 (4) 4运行设计 (4) 4.1运行模块组合 (4) 4.2运行控制 (4) 4.3运行时间 (4) 5系统数据结构设计 (4) 5.1逻辑结构设计要点 (4) 5.2物理结构设计要点 (4) 5.3数据结构与程序的关系 (4) 6系统出错处理设计 (5) 6.1出错信息 (5) 6.2补救措施 (5) 6.3系统维护设计 (5)

概要设计说明书 1引言 1.1编写目的 说明编写这份概要设计说明书的目的，指出预期的读者。 1.2背景 说明： a.待开发软件系统的名称； b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出有关的参考文件，如： a.本项目的经核准的计划任务书或合同，上级机关的批文； b.属于本项目的其他已发表文件； c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的 标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2总体设计 2.1需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。 2.2运行环境 简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。

软件详细设计说明书模板

New Project 1: 详细设计说明书

1. 前言 2. 摘要 3. 系统详细需求分析 3.1. 详细需求分析 3.1.1. 详细功能需求分析 3.1.2. 详细性能需求分析 3.1.3. 详细信息需求分析 3.1. 4. 详细资源需求分析 3.1.5. 详细组织需求分析 3.1.6. 详细系统运行环境及限制条件需求分析3.1.7. 信息要求 3.1.8. 性能要求 3.2. 接口需求分析 3.2.1. 系统接口需求分析 3.2.2. 现有软、硬件资源接口需求分析

3.2.3. 引进软、硬件资源接口需求分析 4. 总体方案设计 4.1. 系统总体结构 4.1.1. 系统组成、逻辑结构 4.1.2. 应用系统结构 4.1.3. 支撑系统结构 4.1.4. 系统集成 4.1. 5. 系统工作流程 4.2. 分系统详细界面划分 4.2.1. 应用分系统与支撑分系统的详细界面划分 4.2.2. 应用分系统之间的界面划分 5. 应用分系统详细设计 5.1. XX分系统详细需求分析 5.1.1. 功能详细需求分析 5.1.2. 性能详细需求分析

5.1.3. 信息详细需求分析 5.1.4. 限制条件详细分析 5.2. XX分系统结构设计及子系统划分5.3. XX分系统功能详细设计 5.4. 分系统界面设计 5.4.1. 外部界面设计 5.4.2. 内部界面设计 5.4.3. 用户界面设计 6. 数据库系统设计 6.1. 设计要求 6.2. 信息模型设计 6.3. 数据库设计 6.3.1. 数据访问频度和流量 6.3.2. 数据库选型 6.3.3. 异构数据库的连接与数据传递方式

软件详细设计文档模板(最全面)

研发生产中心文档编号版本A1 密级商密A 项目名称Xx系统 项目来源 Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录

序号变更（+/-）说明作者版本号日期批准1 2

目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量 (7) 2.2 变量 (8) 2.3 数据结构 (8) 3. 模块设计 (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块1 (10) 3.2.2 模块2 (11) 4. 接口设计 (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计 (12) 6. 系统安全保密设计 (12) 6.1 说明 (12) 6.2 设计 (12) 6.2.1 数据传输部分 (12) 6.2.2 IP过滤分部 (13) 6.2.3 身份验证部分 (13) 7. 系统性能设计 (13) 8. 系统出错处理 (13)

1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号术语或缩略语说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； c．引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]

软件著作权设计说明书范本资料

软件著作权-说明书范本（二） 设计说明书 中国版权保护中心接收登记的文档包含两种：操作说明书或设计说明书。 设计说明书适合没有界面的嵌入式软件，插件软件，后台运行软件以及游戏软件。一般包含结构图，软件流程图，函数说明，模块说明，数据接口，出错设计等。 操作说明书适合管理类软件，有操作界面，一般应包含登录界面，主界面，功能界面截图，截图之间有相应的文字说明，能全面展示软件的主要功能。 格式要求：一、说明书应提交前、后各连续30页，不足60页的，应当全部提交。 二、说明书页眉应标注软件的名称和版本号，应当与申请表中名称完 全一致，页眉右上应标注页码，说明书每页不少于30行，有图除 外，另外截图应该清晰完整。 范例如下： 设计说明书

一、引言 目的 编写详细设计说明书是软件开发过程必不可少的部分，其目的是为了使开发人员在完成概要设计说明书的基础上完成概要设计规定的各项模块的具体实现的设计工作。 二、软件总体设计 2.1软件需求概括 本软件采用传统的软件开发生命周期的方法，采用自顶向下，逐步求精的结构化的软件设计方法。 本软件主要有以下几方面的功能 (1)连接设备 (2)提取数据 (3)保存数据 (4)删除仪器数据 (5)查看历史数据 定义 本项目定义为一个典型的多点互动探伤软件。它将实现多点设备和系统程序的无缝对接，以实现多点互动功能。 2.2需求概述 1.要求利用PQLib硬件商提供的SDK开发出对应的触摸屏系统。 2.系统要显示图片，并实现图片相关所有的多点操作，包括放大，缩小，旋转，平移的功能。 3.要提供美观的图片菜单，在菜单中要提供必要的图片简介信息。 4.系统图片的维护更新要方便。 2.3条件与限制 系统开发的条件是普通PC以及相对应的系统，本次开发所用的系统是WINDOW SERVER2003以及ADOBE FlashCS4。由于硬件开发商提供的开发文档不是很详尽，这对系统开发产生了一定限制影响。 总体设计 2.4总体结构和模块接口设计 系统整体结构框架如图

软件设计文档国家标准GB8567

软件设计文档国家标准GB8567-88 一、文档编写标准化 在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。 完备的文档对软件的开发及使用起了很大的作用。一般要求编写好十三种文档。 1、可行性分析报告 说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 2、项目开发计划 为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 3、软件需求说明书（软件规格说明书） 对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 4、概要设计说明书 是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。 5、详细设计说明书 着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 6、用户操作手册 详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。 7、测试计划 包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。8、测试分析报告 测试计划的执行情况，对测试结果的分析，提出测试结论。 9、开发进度月报 按月提交的项目进展情况报告。包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。 10、项目开发总结报告 项目完成以后，总结实际执行情况。如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。 11、软件维护手册 主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。12、软件问题报告 记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。13、软件修改报告 软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能出现影响作出详细描述，提交审批。 二、可行性分析报告的撰写要求 可行性研究报告的编写内容要求如下： 1 引言

程序设计报告模板

北京化工大学计算机科学与技术专业2014程序设计实训报告 题目：个人记账软件 专业：计算机科学与技术 班级：计科1305 指导教师：江志英

2014程序设计实训任务书

目录 2014程序设计实训任务书...................................... 错误!未定义书签。目录..................................................... 错误!未定义书签。第一章需求分析.............................................. 错误!未定义书签。 引言............................................... 错误!未定义书签。 任务概述........................................... 错误!未定义书签。 数据描述........................................... 错误!未定义书签。 功能需求........................................... 错误!未定义书签。 运行需求........................................... 错误!未定义书签。 任务计划........................................... 错误!未定义书签。第二章概要设计.............................................. 错误!未定义书签。 总体设计........................................... 错误!未定义书签。 面向对象设计....................................... 错误!未定义书签。 运行界面设计....................................... 错误!未定义书签。第三章详细设计.............................................. 错误!未定义书签。 ........................................................ 错误!未定义书签。第四章测试分析............................................. 错误!未定义书签。第五章用户手册（可选）..................................... 错误!未定义书签。第六章课程设计总结.......................................... 错误!未定义书签。附录：程序代码（仅电子版需要、纸质版不需要）................. 错误!未定义书签。

软件开发文档模板库

软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1

1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题

软件设计文档国家标准-概要设计说明书

概要设计说明书 1引言 1.1编写目的 1.2背景 1.3定义 1.4参考资料 2总体设计 2.1需求规定 2.2运行环境 2.3基本设计概念和处理流程 2.4结构 2.5功能器求与程序的关系 2.6人工处理过程 2.7尚未问决的问题 3接口设计 3.1用户接口 3.2外部接口 3.3内部接口 4运行设计 4.1运行模块组合 4.2运行控制 4.3运行时间 5系统数据结构设计 5.1逻辑结构设计要点 5.2物理结构设计要点 5.3数据结构与程序的关系 6.1出错信息 6.2补救措施 6.3系统维护设计 1引言 1.1编写目的 说明编写这份概要设计说明书的目的，指出预期的读者。

1.2背景 说明： a.待开发软件系统的名称； b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出有关的参考文件，如： a.本项目的经核准的计划任务书或合同，上级机关的批文； b.属于本项目的其他已发表文件； c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标 题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2总体设计 2.1需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。2.2运行环境 简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。 2.3基本设计概念和处理流程 说明本系统的基本设计概念和处理流程，尽量使用图表的形式。 2.4结构 用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系. 2.5功能器求与程序的关系

软件设计说明书范本

编号∶______ 版本∶______ 软件详细设计说明书 项目名称：xxxxxxxxxxxx子系统 委托单位： 承办单位： 编写: xxxxxx 2002 年05 月01 日 校对: xxxxxx 2002 年05 月10 日 审核: xxxxxx 2002 年05 月15 日 批准: xxxxxx 2002 年05 月25 日

目录 1.引言 (3) 1.1目的 (3) 1.2背景 (3) 1.3参考资料 (3) 2.总体设计 (4) 2.1软件描述 (4) 2.2设计方法 (4) 2.3软件结构 (4) 2.4模块设计说明 (10) 2.4．1总控模块 (10) 2.4．2所长室模块 (10) 2.4.3综合室模块 (18) 2.4.5 机械一室模块 (27) 2.4.6 机械二室模块 (31) 2.4.7 化工一室模块 (36) 2.4.7化工二室模块 (40) 2.4.8电器室模块 (40) 2.4.9轻工室模块 (40) 2.4.10统计汇总模块 (41) 2.4.11领导查询模块 (41) 2.4.12公共查询模块 (42)

1.引言 1.1目的 编写详细设计说明书是软件开发过程必不可少的部分，其目的是为了使开发人员在完成概要设计说明书的基础上完成概要设计规定的各项模块的具体实现的设计工作。 1.2背景 一、软件名称 检测信息系统质量监督检验子模块 二、相关单位 委托单位∶技术检测中心 承办单位∶石油大学(华东) 主管部门∶技术检测中心信息中心 1.3参考资料 1、<<石油工业应用软件工程规范>> SY/T 5232-1999 2、实用软件工程郑人杰清华大学出版社

软件设计说明书

软件设计说明书 1引言 1.1编写目的 说明编写详细设计方案的主要目的。 说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。 如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计说明书中不重复部分合并编写。 方案重点是模块的执行流程和数据库系统详细设计的描述。 1.2背景 应包含以下几个方面的内容： A. 待开发软件系统名称； B. 该系统基本概念，如该系统的类型、从属地位等； C. 开发项目组名称。 1.3参考资料 列出详细设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时说明如何得到这些资料。 1.4术语定义及说明 列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。 2设计概述 2.1任务和目标 说明详细设计的任务及详细设计所要达到的目标。 2.1.1需求概述 对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。 2.1.2运行环境概述

对本系统所依赖于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。 2.1.3条件与限制 详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。 2.1.4详细设计方法和工具 简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、IDEF（I2DEF）方法、E－R图，数据流程图、业务流程图、选用的CASE工具等，尽量采用标准规范和辅助工具。3系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。 3.1详细需求分析 包括： ?详细功能需求分析 ?详细性能需求分析 ?详细资源需求分析 ?详细系统运行环境及限制条件分析 3.2详细系统运行环境及限制条件分析接口需求分析 包括： ?系统接口需求分析 ?现有硬、软件资源接口需求分析 ?引进硬、软件资源接口需求分析 4总体方案确认 着重解决系统总体结构确认及界面划分问题。 4.1系统总体结构确认 对系统组成、逻辑结构及层次进行确认，对应用系统、支撑系统及各自实现的功能进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括：

范例-软件设计说明(详细部分)

软件设计说明

目录 1范围 (1) 1.1标识 (1) 1.2系统概述 (1) 1.3文档概述 (1) 2引用文档 (1) 3CSCI 级设计决策 (1) 4CSCI 体系结构设计 (2) 4.1CSCI部件 (2) 4.2执行方案 (3) 4.3接口设计 (3) 4.3.1接口标识和接口图 (3) 4.3.x （接口的项目唯一标识符） (4) 5CSCI 详细设计 (6) 5.X （软件单元的项目唯一标识符，或者一组软件单元的标志符） (6) 6需求可追踪性 (9) 7注解 (11) 附录A (11)

软件设计说明 1范围 1.1标识 要求：本节应包含这个文档所适用的系统和软件的完全标识，（若适用）应包括标识号、名称、缩略名、版本号及发布号。 1.2系统概述 要求： 1）本节主要描述本文档适用的系统和软件的用途； 2）概述系统开发、运行和维护的历史； 3）标识项目的投资方、需方、用户、开发方和保障机构； 4）标识当前和计划的运行现场； 5）列出其它有关文档。 1.3文档概述 本节应概述本文档的用途和内容，描述与它的使用有关的保密性或私密性考虑。 2引用文档 列出引用的所有文档，包括文档的编号、标题、修订版本和日期。 3CSCI 级设计决策 要求：本章应根据需要分节给出CSCI 级设计决策，即CSCI 行为设计的决策（忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求）和其它影响组成该CSCI 的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI 的软件单元的设计时指出，则本章应如实陈述。 针对关键性需求（例如对安全性、保密性、私密性等需求）作出的设计决策，应在专门的章节中加以叙述。 CSCI 级设计决策的例子如下： 1）关于CSCI 将接收的输入和将产生的输出的设计决策，包括与其它系统、HWCI、CSCI 和用户的接口（本文档的4.3.x 节指出本说明要考虑的主题）； 2）有关响应每个输入或条件的CSCI 行为的设计决策，包括CSCI 要执行的动作、响应时间和其它性能特性，模型化的物理系统的说明，选定的方程式/算法/规则，以及对不允许的输入或条件进行的处理； 3）有关数据库/数据文件如何呈现给用户的设计决策（本文档的4.3.x 节标识了本说明

软件工程国家标准

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. 控制精度或生产能力的提高。

软件架构设计文档模板

Software Architecture Document Version <1.0> Revision History Date Version Description Author < yyyy-mm-dd >