一．引言
1.1编写目的
本文档作为***与XXXXXXXXXX公司之间就***建立XXXX司（局或单位）XXXXXXXXXX系统需求理解达成一致共识的基础文件，作为双方界定项目范围、签定合同的主要基础，也作为本项目验收的主要依据。同时，本文档也作为***XXX 后继工作开展的基础，供双方项目主管负责人、项目经理、技术开发人员、测试人员等理解需求之用。
1.2适用范围
本文档适用于所有与本项目有关的软件开发阶段及其相关人员，其中：***方面的项目负责人、公司方项目经理、技术开发人员（包括分析人员、设计人员、程序人员）、测试人员应重点阅读本文档各部分，其他人员可选择性阅读本文档。
1.3文档概述
本文档主要描述了XXXXXXXXXX系统项目的软件总体设计思路。
本文档首先从业务背景、系统功能、运行环境等方面概要描述系统，其次从设计原则、功能设计、数据结构设计等方面描述系统的总体设计情况，然后进一步详细描述系统技术实现策略、项目实施以及待确定的问题。
1.4参考资料
[列出本文的参考文件清单，包括出版单位、作者、版本、日期等信息。]示范：―――仅供参考，不具备任何实质性的内容。
《XXX总体需求书》（XXX单位XXX提供）
《XXX需求调研报告》作者：XXX
《设计模式》 XXXXXX出版社
《UML用户指南》 XXXXXXX出版社
1.5术语、定义和缩写
[列出本文档所涉及的专业术语、缩写词及相关定义。定义所有必要的术语，以便读者可以正确地解释软件需求规格说明，包括词头和缩写。你可能希望为整个公司创建一张跨越多项项目的词汇表，并且只包括特定于单一项目的软件需求规格说明中的术语。]
示范：―――仅供参考，不具备任何实质性的内容。
1)OLTP：On-line Transaction Processing，联机事务处理。
2)OLAP：On-Line Analytical Processing，联机分析处理；是使分析
人员、管理人员或执行人员能够从多角度对信息进行快速、一致、交互
地存取,从而获得对数据的更深入了解的一类软件技术。
二．总体概述
2.1现有系统描述
[简要描述客户现有系统的功能、性能以及其他方面，若客户没有系统，则可裁减。另外，可描述客户现有系统的应用状况以及系统规模、人员使用状况。描述客户对象的应用环境平台，如软件环境、硬件环境、网络环境、通讯状况以及人员计算机使用水平等。]
示范：―――仅供参考，不具备任何实质性的内容。
针对金融快报工作，***以前曾开发过一个C/S结构的系统，后台数据库为SQL Server，开发工具是VB6.0。该系统主要完成以下工作：
1.根据人行各业务司局每日上报的数据传真，将数据补录到系统中。
2.根据上报的数据制作金融快报文档。
3.将金融快报的数据转发到人行时间序列数据库中。
金融快报系统的工作流程如下：
2.2存在问题
[通过上述现状描述，分析现有组织结构、现有系统等方面存在的问题。]示范：―――仅供参考，不具备任何实质性的内容。
该系统初步满足了金融快报工作的要求，但是，当前由于各级领导对快报内容的要求不断变化，系统无法通过参数配置来满足日益变化的内容要求。同时，由于系统的C/S架构特点，系统无法实现各业务司局自行报送统计数据的要求，因此需要对原系统进行改进以满足业务的需要。
2.3系统建设目标
[简要说明本项目或系统的总体目标，即建成什么样的应用系统。]
示范：―――仅供参考，不具备任何实质性的内容。
新的系统基于B/S结构，更加适合金融快报“快”的特点，打破了原系统过多依赖外部介质的陈规，以简便、易用为设计思想，以所见即所得为设计指导，以***内联网为传媒，真正实现了业务人员自主报送，管理人员专注管理工作。
2.4需求概述
[可以用图表的形式给出总体业务流程图，并简要描述总体业务流程，业务范围和要求。以图表的形式给出隶属于总体业务流程图的子系统业务流程图并描述子系统业务流程。简要描述（子）业务规则，如智能化的计算规则，数据抽取、加载规则等业务规则。简要描述用户层的需求，可用图表的形式给出。若不需要在此表述，可裁剪。简要描述功能性和非功能性需求，可以图表的方式给出。]示范：―――仅供参考，不具备任何实质性的内容。
为了能使金融快报处理工作更方便，适合报表样式灵活变动的特点，***调查统计司提出：新的金融快报系统应该结合数据交换技术架构体系，由各司局人员自由报数；在金融快报系统内生成金融快报WORD文档、EXCEL文件和生成时间序列数据文件；采用灵活指标模式，方便添加指标；采用灵活的模板定制模式，方便更换报送文件模板。
2.5新系统功能
[可以用图表的形式列出新系统具有哪些功能，特别是特色功能，并简要描述新系统的功能。]
示范：―――仅供参考，不具备任何实质性的内容。
这套金融快报信息系统主要包含以下几个方面的功能：
1.数据报送，帮助各业务司局方便的将数据录入到系统中。
2.数据管理，帮助调查统计司综合处对报送的数据进行审核。
3.快报输出，根据收集到的数据进行整理加工，并将数据的结果按照国
办与中办的要求进行输出。
4.数据转发，收集到的数据按照接口的要求转送时间序列数据库。
5.系统管理，对系统的用户、权限进行管理。
6.配置管理，对数据报送的格式、金融快报的模版以及转发时间序列数
据库的要求进行配置管理。
三．系统设计
3.1设计原则
[简要描述本业务系统总体设计原则和设计依据。]
3.1.1总体设计路线
[描述本业务系统总体设计路线。]
示范：―――仅供参考，不具备任何实质性的内容。
金融快报系统参考现有系统设计方案，采用B/S结构进行系统设计，提供与数据交换平台进行数据传输的软件接口，提供灵活的指标，模板定制方案，极大地提高金融快报处理工作效率。
3.1.2总体技术架构
[以图表的形式勾画出新系统的体系结构图，应包括与外部应用系统的连接，硬件设备的连接，网络系统的连接等。]
示范：―――仅供参考，不具备任何实质性的内容。
3.1.3总体功能架构
[可以用图表的形式列出那些与应用程序自动进行数据处理的过程相对应、需要通过用户交互来完成的处理过程。对于每种角色描述，应指出这种角色能够胜任哪些任务，有多少用户可能具备这种角色，以及（在可能情况下）这种角色
能够在工作流批准或状态改变中充当哪些处理过程。
可以用图表的形式列出本应用系统有哪些程序模块，每个模块的功能是什么。]
示范：―――仅供参考，不具备任何实质性的内容。
金融快报系统的源数据由各司局人员在线报送得到，经过金融快报管理员处理后生成要报送的数据文件进行数据报送，整个金融快报系统工作流程如下：
首先，各司局人员通过数据交换平台进行业务数据报送，系统接收数据后自动对当天数据进行加锁处理，如果业务人员需求重报数据，则需要通知系统管理员进行数据解锁。数据上报完毕后，管理人员对数据进行数据查看和数据修改，可以对要生成的文件添加注释等。处理完毕后，可以生成、下载快报文件和时间序列文件。
系统功能图如下：
3.1.4系统功能部署
[把系统功能的部署情况逐一表述清楚。]
示范：―――仅供参考，不具备任何实质性的内容。
金融快报所有模块均部署于服务器端，功能分别由金融快报管理信息系统模块和通用数据交换平台中的数据采集模块共同实现。其中通用数据交换平台实现单点登陆、权限验证、数据上报功能，而金融快报管理信息系统实现快报的系统管理、数据管理和文件生成等功能。
3.1.5系统特点
[把系统的新特点情况逐一表述清楚。]
示范：―――仅供参考，不具备任何实质性的内容。
金融快报系统具有以下特点：
良好的可扩充性和通用性：灵活多样的数据采集方式与报表定义模式，
方便用户采集各种数据。
贴心的模板定制体系：采用大众熟悉的MS EXCEL所见即所得报表定
义,无需特殊培训，可以使业务人员轻松实现报表定义。
3.2系统用户
[列出本系统全部用户的整体信息。]
示范：―――仅供参考，不具备任何实质性的内容。3.2.1普通用户
[描述本系统的普通用户的整体信息。]
示范：―――仅供参考，不具备任何实质性的内容。3.2.2登录用户
[描述本系统的登录用户的整体信息。]
示范：―――仅供参考，不具备任何实质性的内容。3.2.3访客
[描述本系统的访问用户的整体信息。]
示范：―――仅供参考，不具备任何实质性的内容。3.2.4部门管理员
[描述本系统的部门级别管理员的整体信息。]
示范：―――仅供参考，不具备任何实质性的内容。3.2.5系统管理员
[描述本系统的系统管理员的整体信息。]
示范：―――仅供参考，不具备任何实质性的内容。3.2.6信息子系统
[列出本系统所含盖的全部子系统的参考清单等信息。]示范：―――仅供参考，不具备任何实质性的内容。
3.3系统功能设计——示例
[列出本系统的功能参考文件清单。]
示范：―――仅供参考，不具备任何实质性的内容。
3.3.1快报版本管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
管理生成快报文件的版本。
3.3.2快报文件结构管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
管理快报文件的机构，内容和顺序。
3.3.3文件内容管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
管理用于生成快报文件的文件内容。
3.3.4指标信息管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
定义文件中所采用的指标信息。
3.3.5快报生成模板管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
编制定义金融快报中用来生成快报，转换数据查看，转换数据修改的模板文件。
3.3.6数据采集模板管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
编制定义用来在线报数，原始数据查看，原始数据修改的模板文件。
3.3.7报送机构信息管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
登记、维护要进行报送的司局信息。
3.3.8报送规则维护——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
管理各司局要报送的数据属性。
3.3.9系统常量信息维护——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
管理系统中的常量信息，如文件存放路径等。
3.3.10快报管理——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
通过快报管理，用户可根据模版选择生成金融快报，并可对历史各期快报进行分类检索。
3.3.11数据查询——示例
[列出本模块实现的基本功能点等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
金融快报管理员通过该功能查询各监管司局的各期报送数据。
3.4数据结构设计
[以图表的形式列出本应用系统的数据结构并予以说明。]
示范：―――仅供参考，不具备任何实质性的内容。
3.5接口设计
1）内部接口设计
[以图表的形式列出本应用系统内部的数据接口、通信接口、应用接口设计，并予以说明。]
2）外部接口设计
[以图表的形式列出本应用系统与外部应用系统的接口设计，包括数据交换、网络通信等外部接口设计，并予以说明。]
3）与其他网络系统的接口设计
[以图表的形式列出本应用系统与其他网络系统的接口设计，包括网络协议，通信接口、数据传输接口等，并予以描述。]
示范：―――仅供参考，不具备任何实质性的内容。
3.6系统性能及安全设计
[详细描述对于新系统的性能、安全性以及其他非功能性等方面是如何考虑设计的，如系统响应速度，数据处理速度、网络传输速度、数据加密、权限设计等方面。]
示范：―――仅供参考，不具备任何实质性的内容。
四．实现策略
4.1技术策略
[从技术角度详细说明如何来实现新应用系统，采取哪些新技术，如何确保技术实现。]
示范：―――仅供参考，不具备任何实质性的内容。
4.1.1B/S结构体系——示例
4.1.2JAVA/JNDI技术——示例
4.1.3LDAP技术——示例
4.2安全策略
[从实现的角度来说明如何实现安全设计，采取哪些安全策略来确保新系统能满足安全要求，如数据加密，CA认证、防火墙等。]
示范：―――仅供参考，不具备任何实质性的内容。
4.3数据存储备份策略
[说明应用系统如何实现数据存储备份，应采取哪些策略，应遵循哪些存储规则和规范。]
示范：―――仅供参考，不具备任何实质性的内容。
4.4系统整合策略
[说明本应用系统如何与其他系统进行整合，如何整合，采取哪些技术策略，整合后的系统如何确保性能最优，如何优化。]
示范：―――仅供参考，不具备任何实质性的内容。
五．运行环境
[以图表的形式列出新系统运行的服务器平台环境，如操作系统、以及诸如IIS、Microsoft SQL Server?之类的必要应用程序。同时，描述所有需要相关数据结构及身份验证协议支持的特定需求。
以图表的形式列出客户端环境需求与限制的相关细节，如CPU、操作系统、内存、存储容量、硬件、应用软件等。
以图表的形式列出服务器与客户端以及远程访问所需要的网络环境，如硬件环境（路由器、网关、防火墙等），网络带宽、传输速度、网络协议等。]
5.1硬件环境
[列出硬件环境等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
服务器端：
取决于数据库产品和应用服务器产品，应用程序本身没有严格要求。
客户端：
奔腾133以上，32M以上内存。
5.2软件环境
[列出软件环境等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
服务器端：
操作系统：Windows 98 、Windows NT 4.0、Windows 2000中文版
应用软件：Office2000中文版，Excel和Word
WEB服务：IIS+MS .Net FrameWork V1.14
数据库： SQL Server 2000
开发平台：Microsoft Visual https://www.doczj.com/doc/599008601.html,
客户端：
浏览程序：IE浏览器5.0版本或者以上
5.3开发工具
[列出开发工具文件清单，包括出版单位、作者、版本、日期等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
六．项目实施
6.1工程实施内容
[列出具体的项目工程实施内容等信息。]
示范：―――仅供参考，不具备任何实质性的内容。
根据对项目需求的分析以及金融快报的业务特点，初步确定工程的开发内容
如下表：
功能分类模块开发内容
系统管理
快报版本管理模板管理对快报版本的维护报送模板管理模板管理对报送模板的维护
采集模板管理模板管理对采集模板的维护采集指标管理系统基本管理对采集指标的维护报送指标管理系统基本管理对报送指标的维护
转换关系管理系统基本管理对指标的转换关系维护报送规则管理系统配置对报表的报送规则维护时间序列指标管理系统基本管理对要生成时间序列指标
数据采集
数据报送数据上报对业务数据进行数据上报处理数据加、解锁数据维护对已经上报的数据进行加、解锁
判断和相关处理
数据查看数据上报、数据维护查看已经上报的数据
数据处理数据查看数据维护根据条件查看已经上报的数据数据修改数据维护对已经上报的数据和要生成的
数据进行数据修改
文件处理
快报文件生成文件处理生成指定数据时间的快报文件，
包括WORD文件和EXCEL文件
快报文件下载文件处理下载已经生成的WORD文件和
EXCEL文件
时间序列文件生成文件处理生成指定数据时间和项目的时
间序列文件
时间序列文件下载文件处理下载已经生成的时间序列文件
6.2工程实施计划
[列出具体的项目工程实施计划信息。]
示范：―――仅供参考，不具备任何实质性的内容。
根据对开发内容的分析初步确定工程的实施计划如下表：编号阶段任务描述起止时间
1需求调研
了解具体需求，形成调研报
告2004-7-15—2004-7-31
2需求分析详细分析需求、确认需求，2004-8-1—
形成需求规格说明书2004-8-20
3概要设计
与详细设
计
进行概要设计，形成数据库
设计说明书、概要设计说明
书，详细设计说明书
2004-8-20—
2004-9-30
5编码代码编写，形成程序
2004-10-8—
2004-10-30
6测试
单元测试、集成测试、测试
修改2004-11-1—2004-11-30
7试运行系统试运行
2004-12-1—
2004-12-31
工程开发总周期为5个月，试运行1个月。开发及试运行阶段总人力估计：12人/月。
6.3售后服务与技术支持
[以图表的形式给出实施本项目需要的培训及其时间、人员等。说明本项目需要哪些技术支持，需要什么类型的技术支持人员，以及给客户提供什么样的技术支持，以什么方式提供支持。]
示范：―――仅供参考，不具备任何实质性的内容。
技术培训
项目实施结束后，XXX和XXXXXX公司将就系统使用、系统管理对用户进行培训，并提供详尽的用户手册和管理员手册。
现场技术服务
在遇到紧急事故需要进行现场处理的情况下，XXX和XXXXXXX公司承诺自系统验收合格之日起，提供日常到达现场维护保证（不可抗拒原因除外）。
XXX和XXXXXX公司工程师将定期走访用户，解决用户问题，并提供技术建议。
技术资料服务
XXX和XXXXXX公司将通过E-mail（或上门的方式）向用户提供最新的产
品和技术信息，包括网络故障处理案例资料、业务开放技术案例／方案、新技术新设备资料以及相关维护技术文档以及软件／程序漏洞发现通知。并定期举行技术交流活动。
热线技术支持
XXX和XXXXXXX公司提供本项目的日常热线技术支持，随时解答问题、排除故障。
E-Storage Management System Software Requirements Specification 电子化仓储管理系统软件需求规格说明书 版权所有不得复制 Copyright ? BroadenGate Technologies, Co., Ltd. All Rights Reserved
Revision Record 修订记录
Catalog 目录
错误!未找到引用源。 Keywords 关键词：仓储管理 Abstract 摘要：本文主要描述电子化仓储管理系统的设计需求，包括功能需求和性能需求，以及其他设计约束等。 List of abbreviations 缩略语清单：
1Introduction 简介 1.1Purpose 目的 1.2Scope 范围 本文档包含电子化仓储管理系统V1.0的对外接口和功能描述，以及和外部的约束关系。2General description 总体概述 2.1Software perspective 软件概述 2.1.1About the Project 项目介绍 2.1.2Environment of Pruduct 产品环境介绍 2.2User characteristics 用户特征 2.3Software function 软件功能 2.4Assumptions & Dependencies 假设和依赖关系 3Specific Requirements 具体需求
3.1Functional Requirements 功能需求 我们采用面向对象分析的方法来作为主要的系统建模方法，使用UML(Unified Modeling Language)作为建模语言。UML为建模活动提供了从不同角度观察和展示系统的各种特征的方法。在UML中，从任何一个角度对系统所作的抽象都可能需要几种模型来描述，而这些来自不同角度的模型图最终组成了系统的映像。 Use Case描述的是“actor”(用户、外部系统以及系统处理)是如何与系统交互来完成时，该模型将来可 派生出动态对象模型。 设计Use-case时，我们遵循下列步骤： 第一步： 识别出系统的管理员。管理员可以是用户、外部系统，甚至是外部处理，通过某种途径与系统交互。重要的是着重从系统外部执行者的角度来描述系统需要提供哪些功能，并指明这些功能的执行者是谁。尽可能地确保所有管理员都被完全识别出来。 第二步： 描述主要的Use Case。可以采取不断地问自己“这个管理员究竟想通过系统做什么？”来准确地描述Use Case。 第三步： 重新审视每个Use Case，为它们下了详尽的定义。 电子化仓库管理系统是通过对入库业务、出库业务、仓库调拨、库存调整业务信息的管理，提高仓库管理信息的实时性和准确性，达到即时库存管理的功能，并有效控制并跟踪业务的物流和成本管理全过程，实现完善的企业仓储信息管理。系统中设计了装箱算法，为客户提供合理有效的装箱方案，保证了货物集装箱的利用。本系统可以提供有关库存情况的准确信息，增强了作业的准确性和快捷性、减少了整个物流中由于商品误置、送错、偷窃、损害和库存、出货错误等造成的损耗，并最大限度减少存储成本。 总体功能时序图：（如图3-1所示）
软件开发文档模板 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 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点
《设计和开发输入清单》rm-rdd-jl10-a0项目名称《顾客要求设计和开发输入清单》附相关资料a、产品B的主要功能和性能要求、适用的法律法规，国家强制性标准必须满足C.以往类似设计提供的适用信息D.对确定产品的安全性和适用性至关重要的特性要求说明备注编制/日期评审/批准/日期设计和开发输出清单mx-rdd-jl-09-a0项目名称《设计和开发输出清单》附相关资料；产品设计和开发输出因产品不同而异，包括1份指导生产、包装等活动的图纸和文件。例如：零件图、总装图、生产工艺、包装设计等Mx-rdd-jl-08-a0标题或职务：项目名称：设计开发阶段负责产品编码的审核人；部门职称或职称；部门评审内容：标注“■”表示评审通过；标记“?”表示有建议或疑问；“税”表示不同意。合同与标准的符合性、采购可行性、试验可行性、结构合理性、美观性、环境影响、安全性、评审结论、纠正和改进措施的跟踪验证结果、备注1、评审会议纪要。2可以添加其他页面进行说明。编制/日期评审/日期批准/日期检查员/日期设计和开发验证报告mx-rdd-jl-06-a0项目名称验证单位和参与人员项目编号设计和开发输入汇总绩效、功能，技术参数和标准或基于等的法律法规。主要试验仪器设备的序列号；根据
输入要求的各项专项试验/检测报告的汇总和结论；设计和开发验证的结论；验证结果的跟踪结果，备注可以在另一页中描述。操作员修改日期/设备名称/设备设计人员批准日期/R&；设备设计更改意见日期；D质量管理部部长意见采购部产品设计开发计划负责人mx-rdd-jl-04-a0项目来源项目总负责人项目名称开发周期设计师组成：设计师资源配置：岗位设计师岗位设计师岗位阶段划分及主要内容责任部门负责人完成时间设计任务书编制（设计输入）决策阶段设计任务书评审初步设计技术初步设计评审工作图设计样机试制验证（设计验证）工艺方案评审准备小批量试制工艺文件和检验文件编制试验产品定型鉴定设计确认正式生产前准备转入正式生产设计阶段、试制阶段，定型调试阶段备注材料设计内容可根据实际情况更改编制/日期：审核/日期：批准/日期：日期：
软件开发设计文档
文档管理信息表 主题在线考试系统 版本 1.0 内容基于web的在线考试系统 关键字MVC模式在线考试考生.题库管理 参考文档JSP实用教程（第二版）清华大学出版社（耿祥义.张跃平编著）创建时间2016/7/4 最新发布日期2016/7/6 目录 1 引言 (1) 1.1设计背景 (3) 1.2编写目的 (4) 1.3系统概述 (4) 2开发规划 (4) 2.1开发人员 (4) 2.2开发计划 (4) 2.3开发环境和工具 (5) 3开发设计 (6) 3.1 需求概述 (6) 3.2 软件结构 (7) 3.3基本设计描述 (9) 3.3.1系统总体逻辑结构图 (8) 3.3.2系统部署结构图 (9) 3.4主要界面描述.......................................................................................................错误！未定义书签。 3.4.1用户打开界面............................................................................... 错误！未定义书签。 3.4.2答题界面....................................................................................... 错误！未定义书签。 3.4.2结果显示界面............................................................................... 错误！未定义书签。 3.5模块列表................................................................................................................错误！未定义书签。4数据结构........................................................................................................ 错误！未定义书签。5模块设计. (13) 5.1JSP编辑模块.......................................................................................... 错误！未定义书签。
1．引言 1．1 编写目的 ·阐明开发本软件的目的； 1．2 项目背景 ·标识待开发软件产品的名称、代码； ·列出本项目的任务提出者、项目负责人项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户； ·说明该软件产品与其他有关软件产品的相互关系。 1．3 术语说明 列出本文档中所用到的专门术语的定义和英文缩写词的原文。 1．4 参考资料（可有可无） 列举编写软件需求规格说明时所参考的资料，包括项目经核准的计划任务书、合 同、引用的标准和规范、项目开发计划、需求规格说明、使用实例文档，以及相关产品的软件需求规格说明。 在这里应该给出详细的信息，包括标题、作者、版本号、发表日期、出版单位或资料来源。 2．项目概述 2．1 待开发软件的一般描述 描述待开发软件的背景，所应达到的目标，以及市场前景等。 2．2 待开发软件的功能 简述待开发软件所具有的主要功能。为了帮助每个读者易于理解，可以使用列表或图形的方法进行描述。使用图形表示，可以采用： ·顶层数据流图； ·用例UseCase图； ·系统流程图； ·层次方框图。
2．3 用户特征和水平（是哪类人使用） 描述最终用户应具有的受教育水平、工作经验及技术专长。 2．4 运行环境 描述软件的运行环境，包括硬件平台、硬件要求、操作系统和版本，以及其他的软件或与其共存的应用程序等。 2．5 条件与限制 给出影响开发人员在设计软件时的约束条款，例如： ·必须使用或避免使用的特定技术、工具、编程语言和数据库； ·硬件限制； ·所要求的开发规范或标准。 3．功能需求 3．1 功能划分 列举出所开发的软件能实现的全部功能，可采用文字、图表或数学公式等多种方法进行描述。 3．2 功能描述 对各个功能进行详细的描述。 4．外部接口需求 4．1 用户界面 对用户希望该软件所具有的界面特征进行描述。以下是可能要包括的一些特征： ·将要采用的图形用户界面标准或产品系列的风格； ·屏幕布局； ·菜单布局； ·输入输出格式； ·错误信息显示格式； 建议采用RAD开发工具，比如Visio，构造用户界面。
设计开发输出清单 项目名称型号规格 设计开发输出资料清单 1、项目建议书 2、立项评审报告 3、设计开发输入清单 4、设计开发任务书 5、设计开发任务书评审报告 6、设计开发计划书 7、样机检验报告 8、样机评审报告 9、设计开发验证报告 10、试产报告 11、型式检验报告 12、试产总结报告 13、客户试用报告 14、标准化审查报告 15、产品图 编制：审核：批准：
日期：2006.11 日期：日期： 项目建议书 提出部门建议人 项目名称规格型号 销售对象国内建议日期2006.5 基本要求（包括主要功能、性能、结构、外观包装、技术参数说明等）： 1、负荷：3.26KW。 2、点火方式：压电陶瓷点火、电子脉冲点火。 3、壳：采用不锈钢430材质。 4、燃烧器：采用不锈钢冲压成形。 市场预测分析（包括市场需求、用户期望、竞争对手情况、产品质量。预期首批销量、交货期限、出厂价格等）： 可引用的原有技术： 可行性分析（包括技术、采购、工艺、成本等方面）： 技术、市场、工艺均可行，成本通过论证符合销售成本要求。 项目所需费用，参加人员： 技术开发部、、质管部 部长审核： 签名：日期： 副总经理批示： 签名：日期： 设计开发评审报告
项目名称型号规格 设计开发阶段立项评审负责人 评审人员部门签字评审人员部门签字 秘书处物资部 销售公司开发部 开发部 售后服务部 质管部 评审内容：在“□”内打“√”表示评审通过，“？”表示有建议或疑问，“×”表示不同意。1合同、标准符合性□2采购可行性□3加工可行性□4结构合理性□5可维修性□6可检验性□7美观性□8环境影响性□9安全性□10可靠性□11技术性能实用性□12 □存在问题及改进建议： 评审结论： 对纠正、改进措施的跟踪验证结果： 验证人：日期： 备注：1、评审会议记录应予以保留。2、可另加页叙述。 编制审核批准
XX系统开发 开发团队： 组长： 组员： 备注：广州大学华软软件学院 目录 XX系统开发 (1) 1 概述 (3) 1.1 开发背景 (3) 1.2 开发目标 (3) 1.3 参考资料 (3) 1.4 设计原则 (3) 2 需求分析 (3) 2.1 需求陈述 (3) 2.2 操作用例 (4) 2.3 功能分析划分 (4) 2.3.1 系统登录 (4) 2.3.2 用户管理 (4) (4) 2.5 运行环境 (4) 3 总体设计 (4) 3.1 系统建模 (4)
3.1.1 层次方框图 (4) 3.1.2 ER图（实体-联系图） (4) 3.1.3 类图设计 (5) 3.2 接口设计 (5) 3.2.1 内部接口设计 (5) 3.2.2 登录界面设计 (5) 3.2.3 用户管理界面设计 (5) (5) 3.3 数据库结构设计 (5) 3.3.1 数据库E-R图 (5) 3.3.2 数据库逻辑设计 (5) 2.5 出错处理 (5) 2.6 安全保密设计 (6) 4 详细设计 (6) 4.1 程序流程图 (6) 4.2 伪代码编写 (6) 5 实现 (7) 5.1 编码 (7) 5.1.1 代码约定 (7) 5.1.2 代码编写原则 (7) 5.2 测试要点 (7) 5.2.1 登录测试要点 (7) 5.2.2 主界面测试要点 (7) (7) 5.3 测试结果和总结 (7) 6 维护 (7)
6.1 维护方法 (7) 6.2 维护文档 (7) 6.3 功能拓展方法 (7) 1 概述 1.1 开发背景 【比如为什么要开发这个系统】 1.2 开发目标 【该系统需要完成的基本功能，对系统的大体描述】 1.3 参考资料 【该系统涉及的开源项目等】 1.4 设计原则 【设计该系统遵守的原则，比如支持多数据库，可移植行，可拓展性等】 2 需求分析 2.1 需求陈述 【用平常语言描述该系统的全部功能和细节】
目录 1. 范围 (1) 2. 总体要求 (1) 2.1总体功能要求 (1) 2.2软件开发平台要求 (1) 2.3软件项目的开发实施过程管理要求 (2) 2.3.1 软件项目实施过程总体要求 (2) 2.3.2 软件项目实施变更要求 (2) 2.3.3 软件项目实施里程碑控制 (2) 3. 软件开发 (3) 3.1软件的需求分析 (3) 3.1.1 需求分析 (3) 3.1.2 需求分析报告的编制者 (4) 3.1.3 需求报告评审 (4) 3.1.4 需求报告格式 (4) 3.2软件的概要设计 (4) 3.2.1 概要设计 (4) 3.2.2 编写概要设计的要求 (4) 3.2.3 概要设计报告的编写者 (4) 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 (4) 3.2.5 概要设计的评审 (4) 3.2.6 概要设计格式 (4) 3.3软件的详细设计 (5) 3.3.1 详细设计 (5) 3.3.2 特例 (5) 3.3.3 详细设计的要求 (5) 3.3.4 数据库设计 (5) 3.3.5 详细设计的评审 (5) 3.3.6 详细设计格式 (5) 3.4软件的编码 (5) 3.4.1 软件编码 (5) 3.4.2 软件编码的要求 (5) 3.4.3 编码的评审 (6) 3.4.4 编程规范及要求 (6) 3.5软件的测试 (6) 3.5.1 软件测试 (6) 3.5.2 测试计划 (6) 3.6软件的交付准备 (6) 3.6.1 交付清单 (6)
3.7软件的鉴定验收 (7) 3.7.1 软件的鉴定验收 (7) 3.7.2 验收人员 (7) 3.7.3 验收具体内容 (7) 3.7.4 软件验收测试大纲 (7) 3.8培训 (7) 3.8.1 系统应用培训 (7) 3.8.2 系统管理的培训（可选） (8) 附录A 软件需求分析报告文档模板 (9) 附录B 软件概要设计报告文档模板 (21) 附录C 软件详细设计报告文档模板 (33) 附录D 软件数据库设计报告文档模板 (43) 附录E 软件测试(验收)大纲 ................................................................... 错误！未定义书签。5
目录
(9) 5
1. 范围 本指南用于指导软件开发者为****的过程，通过规范软件项目承担单位的开发过程达到提高软件质量，降低维护成本的目的。开发者应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。在本指南的附录A至E中提供了文档的编写模板供开发者参考，在进行具体软件开发时，开发者可根据实际情况采编写，但必须提供双方约定的文档，文档中约定的内容必须描述清楚。 2. 总体要求 2.1 总体功能要求 网络应用环境以Internet/Intranet技术为核心。 开发者应在充分分析需求的基础上，选择采用B/S结构或者C/S结构。 软件系统的数据库应依照《******规范》进行设计和建设。 本指南中没有规定开发者采用何种具体的软件工程开发方法，开发者可根据项目具体特点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数据的方法，但建议开发商使用面向对象软件工程的方法，如：采用目前被广泛使用的RUP(Rational Unified Process)方法来进行分析、设计和开发。 2.2 软件开发平台要求 开发者开发的软件必须能够在******规定的软件平台上正常运行。目前软件平台为：数据库管理系统： Oracle 9i以上版本 中间件(应用服务器)系统： IBM WebSphere OA系统： Lotus Domino/Notes 网络架构： 完全支持TCP/IP协议 开发工具或技术体系： 为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进行开发，如Microsoft Visual ，Borland Delphi，C++ Builder, 或J2EE(Java2 P1atform Enterprise Edition)等。
目录 1.文档简介4 1.1文档目的4 1.2文档范围4 1.3定义、缩写词和缩略语4 1.4参考资料4 2.架构描述方式4 2.1架构视图阅读指南4 2.2图表与模型阅读指南4 3.架构设计目标5 3.1关键功能5 3.2关键质量属性5 3.3业务需求和约束因素5 4.架构设计原则6 4.1架构设计原则6 4.2备选架构设计方案及被否原因6 4.3架构设计对后续工作的限制（详设，部署等）6 5.逻辑架构视图6 5.1职责划分与职责确定7 5.2接口设计与协作机制8 5.3重要设计包10 6.开发架构视图11 6.1Project划分11 6.2Project 1 11 6.2.1Project目录结构指导11 6.2.2程序单元组织12 6.2.3框架与应用之间的关系（可选）12 6.3Project 2 (13) 6.4Project n (13) 7.运行架构视图13 7.1控制流组织13 7.2控制流的创建、销毁、通信13 7.3加锁设计14 8.物理架构视图14 8.1物理拓扑14 8.2软件到硬件的映射15 8.3优化部署15
9.数据架构视图16 9.1持久化机制的选择16 9.2持久化存储方案16 9.3数据同步与复制策略16 10.关键质量属性的设计原理17
软件开发文档模板库 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. 引言 编写目的 本系统的开发目的在于更好的管理和经营酒店餐饮行业。本文档的预期读者是酒店管理系统软件开发有关的开发人员。 项目背景 本项目的名称：酒店管理系统。 随着国民经济的发展，酒店餐饮行业的队伍在全国范围（尤其是在经济发达地区）不断壮大，从事酒店餐饮行业的单位之间竞争愈加激烈。为了提升自身的竞争能力， 各酒店餐饮单位都在尽量定制或购买各项业务的应用软件，运用高科技手段进行经营 和管理。为了让酒店更好的经营，我们组织开发了本软件。 本项目的任务提出者及开发者是酒店管理系统软件开发小组，主要是面向酒店餐饮服务行业。 定义 酒店管理系统是帮助酒店自身管理和服务酒店客户的软件。 % 参考资料 ①《现代软件工程》北京希望电子出版社孙涌等编著 ②《Delphi住宿餐饮管理系统开发实例导航》人民邮电出版社 刘敬严东明马刚编著 ③《软件需求说明书（GB856T——88）.doc》 ④《iso标准之需求分析说明书.doc》 2.任务概述 目标 开发本软件是为了服务酒店，使得酒店更好的经营。适用于一些大中型酒店，主
要用于就餐管理和住宿管理。本软件产品是一项独立的软件，不过功能还可以增加，完成后可以升级以增加功能和完善系统。 用户的特点 } 使用本软件要求用户熟悉Windows 操作，并且有一定的软件操作基础。预计本软件将会在一些大中型酒店中得到广泛使用。 假定和约束 本软件由我们小组六个人共同开发，几乎不要经费，开发期限一个月左右。3.需求规定 对功能的规定 ①系统帐号管理 第一次用一个管理员账号（系统给定）登陆，登陆成功后，可以设置其他用户，包括密码、权限等。 ②就餐管理 为就餐客户查询并分配餐桌，纪录客户用餐情况并结帐。 ③住宿管理 、 为住宿客户查询并分配房间，纪录客户住宿情况并结帐。 对性能的规定 精度 本软件主要用于管理，不是科学计算，要求计算的精度不是很苛刻。所以输入,输出数据精度的要求不是很高，用于计算的数用浮点数就可以了。 时间特性要求 本软件运行的响应时间要求不超过1～2秒，基本能实现。 灵活性
1. 引言 1.1 目的 说明编写这份报告的目的，指出预期的读者。 1.2 背景 指出待开发的软件系统的名称；行业情况；本项目的任务提出者、开发者、用户；该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 参考资料 列出编写本报告时参考的文件(如经核准的计划任务书或合同、上级机关的批文等)、资料、技术标准，以及他们的作者、标题、编号、发布日期和出版单位。 列出编写本报告时查阅的Intenet上杂志、专业著作、技术标准以及他们的网址。 1.4 术语 列出本报告中用到的专门术语的定义。
2.任务概述 2.1目标 叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中的其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。 2.2系统（或用户）的特点 如果是产品开发，应列出本软件的特点，与老版本软件（如果有的话）的不同之处，与市场上同类软件（如果有的话）的比较。说明本软件预期使用频度； 如果是针对合同开发，则应列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件预期使用频度。这些是软件设计工作的重要约束。3.假定和约束 列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。 4.需求规定 4.1软件功能说明 逐项定量和定性地叙述对系统所提出的功能要求，说明输入什么量、经怎样的处理、得到什么输出，说明产品的容量，包括系统应支持的终端数和应支持的并行操作的用户数等指标。 4.2对功能的一般性规定
软件开发需求文档模板
目录
1. 范围 本指南用于指导软件开发者为南京市交通局开发软件项目的过程，通过规范软件项目承担单位的开发过程达到提高软件质量，降低维护成本的目的。开发者应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。在本指南的附录A至E中提供了文档的编写模板供开发者参考，在进行具体软件开发时，开发者可根据实际情况采编写，但必须提供双方约定的文档，文档中约定的内容必须描述清楚。 2. 总体要求 2.1 总体功能要求 网络应用环境以Internet/Intranet技术为核心。 开发者应在充分分析需求的基础上，选择采用B/S结构或者C/S结构。 软件系统的数据库应依照《南京市交通局信
息化数据库建设规范》进行设计和建设。 本指南中没有规定开发者采用何种具体的软件工程开发方法，开发者可根据项目具体特点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数据的方法，但建议开发商使用面向对象软件工程的方法，如：采用目前被广泛使用的RUP(Rational Unified Process)方法来进行分析、设计和开发。 2.2 软件开发平台要求 开发者开发的软件必须能够在南京市交通局规定的软件平台上正常运行。目前软件平台为： 数据库管理系统： Oracle 9i以上版本 中间件(应用服务器)系统： IBM WebSphere OA系统： Lotus Domino/Notes 网络架构： 完全支持TCP/IP协议 开发工具或技术体系：
为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进行开发，如Microsoft Visual https://www.doczj.com/doc/599008601.html,，Borland Delphi，C++ Builder, 或J2EE(Java2 P1atform Enterprise Edition)等。 2.3 软件项目的开发实施过程管理要求 2.3.1 软件项目实施过程总体要求 （一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行评审，并提出整改意见。 （二）通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行，在开发过程中，开发者需分阶段提交相关文档。 （三）在软件开发工作完成后，开发者应向交通局提交完整的软件文档，交通局组织验收组对软件进行验收审查。 2.3.2 软件项目实施变更要求 在开发过程中，需求或设计不可避免地需要
1引言 编写目的 背景 定义 参考资料 2总体设计 需求规定 运行环境 基本设计概念和处理流程 结构 功能器求与程序的关系 人工处理过程 尚未问决的问题 3接口设计 用户接口 外部接口 内部接口 4运行设计 运行模块组合 运行控制 运行时间 5系统数据结构设计 逻辑结构设计要点 物理结构设计要点 数据结构与程序的关系 6系统出错处理设计
出错信息 补救措施 系统维护设计 **************************************** 2、 ISO9001标准文档模版 第1章引言 编写目的 术语 参考文献 第2章系统概述 系统说明 系统任务 2.2.1 系统目标 2.2.2 运行环境 2.2.3 与其它系统关系 需求规定 2.3.1 功能需求 2.3.2 性能需求 2.3.3 数据要求 2.3.4 其它 第3章总体设计 系统物理结构 3.1.1 系统流程图 3.1.2 设备清单 软件结构图
3.2.1 模块结构图 3.2.2 模块清单 第4章模块功能描述 模块1（标识符）功能 模块2 （标识符）功能 第5章接口设计 用户界面 硬件接口 软件接口 通信接口 第6章数据结构设计 数据结构1 （标识符） 6.1.1 结构属性 6.1.2 逻辑结构 6.1.3 物理结构 6.1.4 数据元素 数据结构2 （标识符） 第7章运行设计 运行1 7.1.1 运行模块组合运行名称 7.1.2 运行控制操作 7.1.3 运行时间 运行2 第8章系统安全 系统安全 数据安全 后备与恢复
出错处理 计算机病毒的防治措施 第9章功能需求、数据结构和模块 功能需求与模块关系 数据结构与模块关系 **************************************** 概要设计说明书 1 引言 写目的：阐明编写概要设计说明书的目的，指明读者对象。 项目背景：应包括 ●项目的委托单位、开发单位和主管部门 ●该软件系统与其他系统的关系。 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。 参考资料： ●列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源 ●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册 ●文档所引用的资料、采用的标准或规范。 2 任务概述 目标 需求概述 条件与限制 3 总体设计 总体结构和模块外部设计
需求分析 1.引言 1.1目的 说明编写这份报告的目的，指出预期的读者。 1.2背景 指出待开发的软件系统的名称；行业情况；本项目的任务提出者、开发者、用户；该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3参考资料 列出编写本报告时参考的文件(如经核准的计划任务书或合同、上级机关的批文等)、资料、技术标准，以及他们的作者、标题、编号、发布日期和出版单位。 列出编写本报告时查阅的Intenet上杂志、专业著作、技术标准以及他们的网 1.4术语 列出本报告中用到的专门术语的定义。 2.任务概述 2.1目标 叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中的其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。
2.2系统（或用户）的特点 如果是产品开发，应列出本软件的特点，与老版本软件（如果有的话）的不同之处，与市场上同类软件（如果有的话）的比较。说明本软件预期使用频度； 如果是针对合同开发，则应列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件预期使用频度。这些是软件设计工作的重要约束。 3.假定和约束 列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。 4.需求规定 4.1软件功能说明 逐项定量和定性地叙述对系统所提出的功能要求，说明输入什么量、经怎样的处理、得到什么输出，说明产品的容量，包括系统应支持的终端数和应支持的并行操作的用户数等指标。 4.2对功能的一般性规定 本处仅列出对开发产品的所有功能（或一部分）的共同要求，如要求界面格式统一，统一的错误声音提示，要求有在线帮助等。 4.3对性能的一般性规定 4.3.1精度 说明对该系统的输入、输出数据精度的要求，可能包括传输过程中的精度。 4.3.2时间特性要求 说明对于该系统的时间特性要求。 4.3.3灵活性 说明对该系统的灵活性的要求，即当需求发生某些变化时，该系统对这些变化的适应能力。 4.4输入输出要求 解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。 对系统的数据输出及必须标明的控制输出量进行解释并举例。
软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（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）对现有软件的影响
目录 1. 范围.............................................................................................................. 错误!未定义书签。 2. 总体要求...................................................................................................... 错误!未定义书签。 2.1总体功能要求 ........................................................................................ 错误!未定义书签。 2.2软件开发平台要求 ................................................................................ 错误!未定义书签。 2.3软件项目的开发实施过程管理要求..................................................... 错误!未定义书签。 2.3.1 软件项目实施过程总体要求........................................................ 错误!未定义书签。 2.3.2 软件项目实施变更要求................................................................ 错误!未定义书签。 2.3.3 软件项目实施里程碑控制............................................................ 错误!未定义书签。 3. 软件开发...................................................................................................... 错误!未定义书签。 3.1软件的需求分析 .................................................................................... 错误!未定义书签。 3.1.1 需求分析........................................................................................ 错误!未定义书签。 3.1.2 需求分析报告的编制者................................................................ 错误!未定义书签。 3.1.3 需求报告评审................................................................................ 错误!未定义书签。 3.1.4 需求报告格式................................................................................ 错误!未定义书签。 3.2软件的概要设计 .................................................................................... 错误!未定义书签。 3.2.1 概要设计........................................................................................ 错误!未定义书签。 3.2.2 编写概要设计的要求.................................................................... 错误!未定义书签。 3.2.3 概要设计报告的编写者................................................................ 错误!未定义书签。 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 ................ 错误!未定义书签。 3.2.5 概要设计的评审............................................................................ 错误!未定义书签。 3.2.6 概要设计格式................................................................................ 错误!未定义书签。 3.3软件的详细设计 .................................................................................... 错误!未定义书签。 3.3.1 详细设计........................................................................................ 错误!未定义书签。 3.3.2 特例................................................................................................ 错误!未定义书签。 3.3.3 详细设计的要求............................................................................ 错误!未定义书签。 3.3.4 数据库设计.................................................................................... 错误!未定义书签。 3.3.5 详细设计的评审............................................................................ 错误!未定义书签。 3.3.6 详细设计格式................................................................................ 错误!未定义书签。 3.4软件的编码 ............................................................................................ 错误!未定义书签。 3.4.1 软件编码........................................................................................ 错误!未定义书签。 3.4.2 软件编码的要求............................................................................ 错误!未定义书签。 3.4.3 编码的评审.................................................................................... 错误!未定义书签。 3.4.4 编程规范及要求............................................................................ 错误!未定义书签。 3.5软件的测试 ............................................................................................ 错误!未定义书签。 3.5.1 软件测试........................................................................................ 错误!未定义书签。 3.5.2 测试计划........................................................................................ 错误!未定义书签。 3.6软件的交付准备 .................................................................................... 错误!未定义书签。 3.6.1 交付清单........................................................................................ 错误!未定义书签。 3.7软件的鉴定验收 .................................................................................... 错误!未定义书签。 3.7.1 软件的鉴定验收............................................................................ 错误!未定义书签。