项目应用系统详细设计说明书.doc

1、项目应用系统详细设计说明书文件编号：SE-E-TP-13文件版本：V1.2密级：内部文件状态：已审核生效日期：单击此处键入项目名称应用系统详细设计说明书版本号发布时间编写人修订人文件审核表文件名称：XXX项目项目计划书编写人：XXX编写时间：YYYY-MM-DD版本号：x.x合作单位相关负责人签字(可多个)签字日期江苏华招网XX客户修订纪录修改人修改原因修改批准人修改完成日期版本号目 录1.引言61.1目的61.2适用对象61.3术语61.4参考资料62.总体设计72.1系统概述72.2设计约束72.3设计策略82.4系统总体结构82.5子系统清单82.6模块清单83.数据库设计93.1数据库

2、环境说明93.2数据库的命名规则93.3逻辑设计93.4物理设计93.4.0表汇总94.4.N 表N103.5数据安全性103.5.1防止用户直接操作数据库的方法103.5.2用户帐号密码的加密方法103.5.3角色与权限103.6优化113.7数据库管理与维护说明114.子系统/模块设计114.1子系统编号1114.1.1接口说明114.1.1.1用户接口124.1.1.2软件接口124.1.1.3其它接口124.1.2模块编号1125.系统运行环境136.开发环境及建议137.测试环境及建议148.其它141. 引言1.1 目的1、 对项目业务系统进行子系统、模块划分，并明确各子系统之间、

3、模块之间的联系2、 对功能模块中所涉及的数据进行细化，并对数据的结构针对关系型数据库进行设计，明确各数据之间的关系和约束3、 明确子系统以及模块之间接口4、 明确哪些利用现有平台功能进行实现，哪些需要单独实现5、 对于使用平台功能的模块，在此文档中描述使用平台哪部分功能，并明确描述在平台上开发的具体要求6、 对于需要单独实现的功能模块需要进行详细设计，必要时采用面向对象的设计方法进行设计7、 对于那些不明确或容易混淆的功能模块需要进行算法级或伪代码级设计1.2 适用对象说明本业务系统设计方案适合的阅读对象。1.3 术语列出本系统设计方案中专门术语的定义和英文缩写词的原词组。缩写、术语解 释1.

4、4 参考资料列出编写参考的文件、资料、技术标准以及他们的作者、标题、编号、发布日期和出版单位。编号资料名称简介作者日期出版单位列出编写本报告时需查阅的Internet上杂志、专业著作、技术标准以及他们的网址。网点简介2. 总体设计2.1 系统概述描述本系统及主要功能。2.2 设计约束（1）需求约束。体系结构设计人员从需求文档（如用户需求说明书和软件需求规格说明书）中提取需求约束，例如： 本系统应当遵循的标准或规范 软件、硬件环境（包括运行环境和开发环境）的约束 接口/协议的约束 用户界面的约束 软件质量的约束，如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可

5、移植性等等。（2）隐含约束。有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，设计人员应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖等。2.3 设计策略体系结构设计人员根据产品的需求与发展战略，确定设计策略（Design Strategy）。例如： 扩展策略。说明为了方便本系统在将来扩展功能，现在有什么措施。 复用策略。说明本系统在当前以及将来的复用策略。 折衷策略。说明当两个目标难以同时优化时如何折衷，例如“时空”效率折衷，复杂性与实用性折衷。2.4 系统总体结构以图表形式给出软件子系统结构和模块组成结构。凡单

6、独编写业务系统设计方案的子系统，其内部自用的模块不必列出。（1）将系统分解为若干子系统，若本系统即为一个子系统，则分解为若干模块，绘制物理图和逻辑图，说明各子系统或模块的主要功能。（2）说明“如何”以及“为什么”（how and why）如此分解系统。（3）说明各子系统或模块如何协调工作，从而实现原系统的功能。2.5 子系统清单子系统编号子系统名称子系统功能简述子系统之间的关系2.6 模块清单模块编号模块名称模块功能简述模块之间关系3. 数据库设计3.1 数据库环境说明（1）说明所采用的数据库系统，设计工具，编程工具等（2）详细配置3.2 数据库的命名规则（1）完整并且清楚的说明本数据库的命名

7、规则。（2）如果本数据库的命名规则与机构的标准不完全一致的话，请作出解释。3.3 逻辑设计数据库设计人员根据需求文档，创建与数据库相关的那部分实体关系图（ERD）。如果采用面向对象方法（OOAD），这里实体相当于类（class）。3.4 物理设计（1）主要是设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成物理设计中的表，但是它们并不一定是一一对应的。（2）对表结构进行规范化处理（第三范式）。3.4.1 表汇总表名功能说明表A表B表C4.4.N 表N表名序号字段代码字段名称类型长度主键为空备注补充说明3.5 数据安全性提高软件

8、系统的安全性应当从“管理”和“设计”两方面着手。这里仅考虑数据库的安全性设计。3.5.1 防止用户直接操作数据库的方法用户只能用帐号登陆到应用软件，通过应用软件访问数据库，而没有其它途径操作数据库。3.5.2 用户帐号密码的加密方法对用户帐号的密码进行加密处理，确保在任何地方都不会出现密码的明文。3.5.3 角色与权限确定每个角色对数据库表的操作权限，如创建、检索、更新、删除等。每个角色拥有刚好能够完成任务的权限，不多也不少。在应用时再为用户分配角色，则每个用户的权限等于他所兼角色的权限之和。角色可以访问的表与列操作权限角色A角色B3.6 优化分析并优化数据库的“时空”效率，尽可能地“提高处理

9、速度”并且“降低数据占用空间”。（1）分析“时空”效率的瓶颈，找出优化对象（目标），并确定优先级。（2）当优化对象（目标）之间存在对抗时，给出折衷方案。（3）给出优化的具体措施，例如优化数据库环境参数，对表格进行反规范化处理等。优先级优化对象（目标）措施3.7 数据库管理与维护说明在设计数据库的时候，及时给出管理与维护本数据库的方法，有助于将来撰写出正确完备的用户手册。4. 子系统/模块设计4.1 子系统编号1（1）将子系统编号1分解为模块（Module），绘制逻辑图（如果物理图和逻辑图不一样的话，应当绘制物理图），说明各模块的主要功能。（2）说明“如何”以及“为什么”（how and why

10、）如此分解子系统M。（3）说明各模块如何协调工作，从而实现子系统M的功能。（4）该子系统与总体设计中的子系统一一对应4.1.1 接口说明4.1.1.1 用户接口描述该软件与用户的接口，包括用户输入输出界面样式、操作方式和界面间的转移关系。4.1.1.2 软件接口描述该软件与其它系统的软件接口，主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口。4.1.1.3 其它接口描述该软件与其它系统的其它类型接口，主要说明其它系统提供的和本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等4.1.2 模块编号1【注：可根据实际情况如下描述可以进行裁剪】模块名称模块描述给出对该程序的简

11、要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重入的还是不可重入的？有无覆盖要求？是顺序处理还是并发处理？等）。功能描述【此处需要说明该模块用来实现哪个功能，与详细设计中的功能进行一一对应】【说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。也可使用伪代码的方式表示。】输入项【给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等】输出项【给出对每一个输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输出的

12、形式数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。】数据与存储说明【包括可能的存储过程设计、触发器设计等。根据需要，说明本程序的存储分配。】算法【详细说明本程序所选用的算法，具体的计算公式和计算步骤。】【对于使用现有平台实现的功能，此处可以描述利用平台实现的过程或原理等等。】接口说明【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。用户界面的设计。】性能说明【说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。】权限设计说明【如果有权限设计，则需说明角色授权的设

13、计。可以用纵横坐标的表格表示。】注释设计【说明准备在本程序中安排的注释，如：l加在模块首部的注释；l加在各分枝点处的注释；l对各变量的功能、范围、缺省条件等所加的注释；对使用的逻辑所加的注释等等。】限制条件【说明本程序运行中所受到的限制条件。】尚未解决的问题【说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。】补充说明【其他描述】5. 系统运行环境给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备上相应软件配置。软件环境包括：操作系统、数据库、以及其它支撑软件；硬件环境包括：主机类型、网络类型、存储器容量、其它特殊设备。类别标准配置最低配置计算机硬件软件网络通信其它6. 开发环境及建议说明本系统应当在什么样的环境下开发，有什么强制要求和建议？类别标准配置最低配置计算机硬件软件网络通信其它7. 测