程序设计-详细设计模板

1、（文档名称）福州星网视易信息系统XXX更新记录：版本整理日期内容10蔡炆炆2010-11-3后台系统详细设计模板1.1蔡炆炆2010-11-5调整设计说明结构目录一、引言21.编写目的22.适用范围23.文档概述24.术语、定义和缩写2二、系统结构21.软件结构22.程序结构23.关键技术2三、设计说明21.程序模块12l需求描述2l功能2l界面设计2l输入项2l输出项2l处理逻辑2l接口2l出入口参数2l限制条件2l测试要点22.程序模块22l需求描述2l功能2l界面设计2l输入项2l输出项2l处理逻辑2l接口2l出入口参数2l限制条件2l测试要点26 / 8一、 引言1. 编写目的本文档作

2、为*与XXXXXXXXXX公司之间就*建立XXXX司（局或单位）XXXXXXXXXX系统需求理解达成一致共识的基础文件，作为双方界定项目范围、签定合同的主要基础，也作为本项目验收的主要依据。同时，本文档也作为*XXX后继工作开展的基础，供双方项目主管负责人、项目经理、技术开发人员、测试人员等理解需求之用。2. 适用范围本文档适用于所有与本项目有关的软件开发阶段及其相关人员，其中：*方面的项目负责人、公司方项目经理、技术开发人员（包括分析人员、设计人员、程序人员）、测试人员应重点阅读本文档各部分，其他人员可选择性阅读本文档。3. 文档概述本文档主要描述了XXXXXXXXXX系统项目的软件详细设计

3、的内容。本文档首先从软件结构、关键技术、程序结构等方面概要描述系统，然后进一步详细描述每一个程序模块的设计说明。4. 术语、定义和缩写列出本文档所涉及的专业术语、缩写词及相关定义。定义所有必要的术语，以便读者可以正确地解释软件需求规格说明，包括词头和缩写。你可能希望为整个公司创建一张跨越多项项目的词汇表，并且只包括特定于单一项目的软件需求规格说明中的术语。示范：仅供参考，不具备任何实质性的内容。1) OLTP：On-line Transaction Processing，联机事务处理。2) OLAP：On-Line Analytical Processing，联机分析处理；是使分析人员、管理人

4、员或执行人员能够从多角度对信息进行快速、一致、交互地存取,从而获得对数据的更深入了解的一类软件技术。二、 系统结构1. 软件结构用一系列图表形式给出软件系统结构。 示范：仅供参考，不具备任何实质性的内容。金融快报系统的实现由日常任务、系统维护、规则维护、工作向导四个部分来完成。日常任务是日程工作的任务，及时了解当前任务和任务状态的展示页面。在这里有查看报送情况，它将会查看到文件的是否报送；数据查看修改是指数据由于某种原因错误，可进行修改的功能；上报数据状态是指报送的文件报送完后，文件被锁定，如果要修改，需要对文件进行解锁；快报生成下载是指数据接收完毕后，生成金融快报完，可以下载浏览。系统维护是

5、用户对本系统的维护，包括快报版本管理、文件信息管理、报表信息管理、文件内容管理、指标信息管理。规则维护是用户对本系统规则的维护，包括收数模板管理、报表模板管理、报送规则管理。工作向导目的是让用户不用学习本软件，就能完成工作流程而开发的工作向导功能。以提示语的形式来引导工作流程。工作向导是由日常工作向导、快报定制向导、数据采集向导2. 程序结构用一系列图表形式列出软件系统每个程序模块（或部件）名称、标识符以及这些程序模块之间的层次关系。 示范：仅供参考，不具备任何实质性的内容3. 关键技术从技术角度说明如何来实现新应用系统，采取哪些技术，如何确保技术实现。 示范：仅供参考，不具备任何实质性的内容

6、。三、 设计说明从本章节开始，逐个地给出各个层次中的每个程序模块的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。 示范：仅供参考，不具备任何实质性的内容。该系统的总体设计思路是采用B/S结构，通过WEB实现金融快报信息管理，利用Web Service和SOAP协议来和交换平台传输数据，实现在线填报数据、修改数据、在线生成快报、在线下载的金融快报的整个过程，数据层是通过SQL Server数据库构建。系统的用例列表如下：下面，将按照用例逐项给出对

7、用例的设计实现1. 程序模块1标识、名称、简要描述。 示范：仅供参考，不具备任何实质性的内容。l 需求描述简要描述该模块或部件或类的业务需求，并标明需求来源（对应于需求规格说明书）。 示范：仅供参考，不具备任何实质性的内容。查看报送情况是根据用户输入来选择时间，来查询文件的报送情况，同时显示文件的时间、文件的编号、文件名称、报送的机构、报送状态，报送状态栏显示的是已经报送，会以白色来告诉用户文件以已经报送，报送状态栏显示的是尚未报送，会以黄褐色来告诉用户文件以尚未报送l 功能详细说明此程序模块所要实现的主要功能，如查询、修改、删除、添加、数据处理等。 示范：仅供参考，不具备任何实质性的内容。该

8、模块要实现用户查看报送文件的是否接收的状态。l 界面设计首先，可将交互的情况在纸面上列出，并用图形工具（如Visio）画出系统中的合理的用户界面。进一步，可使用开发工具实现可运行的原型，请用户体验原型，收集反馈，及时改进。详细设计阶段不需要太关注美术效果等附加的细节，主要在于系统与用户交互的方式。l 输入项描述输入项的特性，包括：名称、标识、数据类型、数据格式、完整性检测（数值的有效范围）、输入方式、输入数据的来源等。并说明采用什么样的输入方式（如采用下拉式列表等），输入项的分组方式和界面安排，以保证输入的方便。 示范：仅供参考，不具备任何实质性的内容。用户通过输入时间条件，查询快报生成情况。

9、1）数据时间（选入项）不可为空；2）快报版本（选入项）不可为空；3）期号（填入项）不可为空；4）报表时间（选入项）不可为空。l 输出项描述输出项的特性，包括：名称、标识、数据类型、数据格式、数值的有效范围、输出方式及其说明等。若输出方式采用屏幕查询方式，应说明需要对什么数据项进行什么样的查询，查询输出格式，仔细说明查询设计要点。若输出方式采用数据打印方式，应说明需要打印什么数据以及要求的打印方式。 示范：仅供参考，不具备任何实质性的内容。（1）点击“查看生成情况”，会输出当天时间的快报生成情况。 文件时间 快报版本 版本描述 文件状态 WORD下载 EXCEL下载(2)点击“查看历史快报”，会

10、输出所有生成快报生成情况。 文件时间 快报版本 版本描述 文件状态 WORD下载 EXCEL下载（3）点击“生成快报”，会输出进度条“快报正在生成中”。（4）点击“WORD下载”，会输出快报文件，以WORD形式输出。l 处理逻辑可根据实际需要，用图表（如流程图）或者过程描述语言来表示本程序所作的处理逻辑流程。可包括正常处理流程、异常处理流程和备用操作流程。 示范：仅供参考，不具备任何实质性的内容l 接口可根据实际需要，分别列出和此模块有调用关系的所有模块及其调用关系，描述与此模块有关的数据结构以及基表、视图等数据库对象，说明其名称及其中文描述。 示范：仅供参考，不具备任何实质性的内容。l 出入

11、口参数可根据实际需要，详细描述本程序模块所有的出入口参数，包括参数内容、参数类型、参数描述等。 示范：仅供参考，不具备任何实质性的内容。l 限制条件可根据实际需要，说明此程序运行所受到的限制条件（或约束）。 示范：仅供参考，不具备任何实质性的内容。l 测试要点可根据测试需要，简要给出测试本程序的主要测试要求，如测试功能项、输入项的完整性检测、数据处理的正确性、测试的注意点等。 示范：仅供参考，不具备任何实质性的内容。2. 程序模块2标识、名称、简要描述。 示范：仅供参考，不具备任何实质性的内容。l 需求描述简要描述该模块或部件或类的业务需求，并标明需求来源（对应于需求规格说明书）。 示范：仅供

12、参考，不具备任何实质性的内容。查看报送情况是根据用户输入来选择时间，来查询文件的报送情况，同时显示文件的时间、文件的编号、文件名称、报送的机构、报送状态，报送状态栏显示的是已经报送，会以白色来告诉用户文件以已经报送，报送状态栏显示的是尚未报送，会以黄褐色来告诉用户文件以尚未报送l 功能详细说明此程序模块所要实现的主要功能，如查询、修改、删除、添加、数据处理等。 示范：仅供参考，不具备任何实质性的内容。该模块要实现用户查看报送文件的是否接收的状态。l 界面设计首先，可将交互的情况在纸面上列出，并用图形工具（如Visio）画出系统中的合理的用户界面。进一步，可使用开发工具实现可运行的原型，请用户体

13、验原型，收集反馈，及时改进。详细设计阶段不需要太关注美术效果等附加的细节，主要在于系统与用户交互的方式。l 输入项描述输入项的特性，包括：名称、标识、数据类型、数据格式、完整性检测（数值的有效范围）、输入方式、输入数据的来源等。并说明采用什么样的输入方式（如采用下拉式列表等），输入项的分组方式和界面安排，以保证输入的方便。 示范：仅供参考，不具备任何实质性的内容。用户通过输入时间条件，查询快报生成情况。1）数据时间（选入项）不可为空；2）快报版本（选入项）不可为空；3）期号（填入项）不可为空；4）报表时间（选入项）不可为空。l 输出项描述输出项的特性，包括：名称、标识、数据类型、数据格式、数值

14、的有效范围、输出方式及其说明等。若输出方式采用屏幕查询方式，应说明需要对什么数据项进行什么样的查询，查询输出格式，仔细说明查询设计要点。若输出方式采用数据打印方式，应说明需要打印什么数据以及要求的打印方式。 示范：仅供参考，不具备任何实质性的内容。（1）点击“查看生成情况”，会输出当天时间的快报生成情况。 文件时间 快报版本 版本描述 文件状态 WORD下载 EXCEL下载(2)点击“查看历史快报”，会输出所有生成快报生成情况。 文件时间 快报版本 版本描述 文件状态 WORD下载 EXCEL下载（3）点击“生成快报”，会输出进度条“快报正在生成中”。（4）点击“WORD下载”，会输出快报文件，以WORD形式输出。l 处理逻辑可根据实际需要，用图表（如流程图）或者过程描述语言来表示本程序所作的处理逻辑流程。可包括正常处理流程、异常处理流程和备用操作流程。 示范：仅供参考，不具备任何实质性的内容l 接口可根据实际需要，分别列出和此模块有调用关系的所有模块及其调用关系，描述与此模块有关的数据结构以及基表、视图等数据库对象，说明其名称及其中文描述。 示范：仅供参考，不具备任何实质性的内容。l 出入口参数可根据实际需要，详细描述本程序