软件工程详细的设计说明书.doc

文档编号： 版本号： 文档名称：详细设计说明书 项目名称：XXX 项目负责人：XX 编写：XX 校对：XX 审核：XX 批准：XX 开发单位：XXXX软件开发小组 1. 引言 1.1 编写目的 在项目小组（系统分析员）提交了软件《概要设计说明书》，并经程序员与系统分析员充分讨论和分析后，由程序员提出了这份软件详细设计说明书。 此详细设计说明书对《XXX》软件的总体设计和各模块的功能、性能、输入输出、算法、接口、程序逻辑、存储分配及其它给出了详细的设计方案，为软件开发制定详细的计划，同时也提交系统分析员，由其提出意见。这是程序员进行开发及未来测试的重要文档资料。 1.2 项目背景 《XXX》软件即提供对个人社会关系数据库系统（Individual Social Connection Database System）的全面高效管理。 委托单位：XXX 开发单位：XXX 主管部门：XXX 1.3 参考资料 [1] XXX [2] XXX [3] XXX [4] Tom.Steve, 《Borland Delphi DataBase Application Development Manual》, Prentice-Hall, 1998. 2. 总体设计 2.1 需求概述 本软件主要提供七方面功能： 1. 浏览功能 ? 列出所有记录（每项记录只列出姓名、单位及部门、办公室电话域）； ? 可选定一项记录，显示所有域； 2. 查询功能 ? 姓名匹配查询； ? 单位及部门匹配查询； ? 电话号码匹配查询（包括多个域）； 3. 修改功能 ? 修改所有的域，姓名不能为空； 4. 增加功能 ? 增加一个新的记录； 5. 删除功能 ? 删除一个记录，提供确认机制； 6. 打印功能 ? 选择特定记录（一个或多个）打印报表； ? 打印信封封面； 7. 快捷功能 ? 以数字键表示特定记录，使用户只需按一个键即可得到所需记录； 2.2 软件结构 软件结构图如上所示。 3. 程序描述 3.1 初始化模块（M1.1） 功能：初始化系统，使系统进入正常工作状态。 输入项目：配置文件，数据库文件。 输出项目：设置全局变量，浏览区和基本资料区。 程序逻辑： P1： 检查配置文件与数据库是否正确（完整性和一致性）。若是，转P4； P2： 根据错误情况产生消息窗口W7； P3： 用户确认后退出程序运行； P4： 由数据库与配置文件设置全局变量1~7； P5： 产生窗口W1，设置各区域； P6： 调用刷新浏览模块M2 .2（arg：hot_record）； P7： 调用刷新基本资料模块M3.2（arg：刷新）； P8： 进入事件等待状态； 存储分配：程序运行需要占用内存约1MB左右。 测试要点：配置文件或数据库文件损坏，或没有足够内存可供使用时是否正常。 3.2 关闭系统模块（M1.2） 功能：关闭并退出系统，保留相应状态数据。 输入项目：全局变量。 输出项目：更新后的数据库文件和配置文件。 程序逻辑： P1： 设置数据库和配置文件； P2： 释放系统资源并退出系统； 测试要点：若数据库文件或配置文件不能正常操作，或全局数据已经不一致，怎样处理。 3.3 浏览模块（M2.1） 功能：维护窗口中浏览区中信息的更改和刷新。 性能：这是经常使用的一个模块，对性能要求在1~2秒内作出反应。 输入项目：鼠标或键盘事件。 输出项目：重新设置的浏览区中信息 程序逻辑： P1： 若事件不是鼠标单击，转P4； P2： 恢复hot_record正常显示，设置新的hot_record并突出显示之； P3： 调用刷新基本资料模块M 3.2（arg：更换），转P13； P4： 若事件不是鼠标双击或回车，转P10； P5： 调用详细资料模块M5； P6： 若返回“修改”，调用修改模块M4.3； P7： 若返回“删除”，调用删除模块M4.5； P8： 若返回“打印”，调用打印模块M4.6； P9： 转P13； P10： 若事件不是上下方向键、pageup/pagedown或点击滚动栏，转P13； P11： 恢复hot_record正常显示，设置新的hot_record并突出显示之； P12： 延迟1秒，此间若无其它事件改变hot_record则调用刷新基本资料模块M3.2（arg：更换），否则不调用； P13： 进入事件等待状态； 测试要点：对各事件进行测试。 3.4 刷新浏览模块（M2.2） 功能：利用全局变量中的信息重新刷新浏览区。 输入项目：将要设置成热点记录的记录号：new_record。 输出项目：设置浏览区。 程序逻辑： P1： 恢复hot_record 正常显示，设置hot_record =new_record； P2： 由全局变量1、2、6设置浏览区； P3： 突出显示hot