软件设计文档完整版

HEN system office room 软件设计文档

【HEN16H-HENS2AHENS8Q8-HENH1688】

软件设计文档

目 录

1

开发规划 ...................................................................

2

开发人员 ................................................................. 开发计划 ................................................................. 开发环境和工具 ........................................................... 开发规范 ................................................................. 总体设计 .................................................................. 6

3 4

概念术语描述 .............................................................

术语1 ...............................................................

术语2 ............................................................... 基本设计描述 .............................................................

系统总体逻辑结构图 ................................................... 系统部署结构图....................................................... 主要界面流程描述 .........................................................

功能1界面流程....................................................... 功能2界面流程....................................................... 模块列表 .................................................................

数据结构 ................................................................... 接口规范 ................................................................. 12

5

<模块1 API> .............................................................

Interface1 .......................................................... Interface2 .......................................................... <模块2 API> ............................................................. <模块3 API> ............................................................. <数据库API> .............................................................

模块设计 ...................................................................

6

MODULE1设计 ..............................................................

模块设计描述 ........................................................ 模块界面描述 ........................................................ MODULE2设计 .............................................. 错误!未定义书签。

附录 .......................................................................

第三方组件 ............................................................... 参考资料 ................................................................. 附加文档 .................................................................

1 开发规划

1.1 开发人员 角 色 主要职责 负责模块 人员 备注 项目经理 PM 项目全面负责 xxx模块 项目设计 主要框架/模块编写 项目进度控制 产品经 定义需求 无 理 产品监督 PT 结果验证（测试） 用户文档 程序员 xxx模块 DEV 程序员 xxx模块 DEV 1.2 开发计划 xxx xxx xxx xxx <附开发计划表>

1.3 开发环境和工具

开发工具

工具 Delphi 7 VBA 1.4 开发规范 文档名称 Delphi编码规范 系统目录规范 作用 客户端 开发Excel插件 Web页面，Web Service 位置 2 总体设计

2.1 概念术语描述 2.1.1 术语1

<术语1的描述>

2.1.2 术语2

<术语2的描述>

2.2 基本设计描述

<文字性的设计思路>

2.2.1 系统总体逻辑结构图

层/包1 模块1 模块2 模块2 2.2.2 系统部署结构图 模块1 模块3 2.3 主要界面流程描述 2.3.1 功能1界面流程 2.3.2 功能2界面流程 2.4 模块列表 模块名称(英文) 模块1 数据库服务器 Module1 模块2 Module2 模块3 Module3 功能 Web服务器 防火墙 备注 VPN/ INTERNET 3 数据结构 数据库表列表 表名 作用 内部客户机 内部客户机 <附SQL数据库结构定义文档> 系统网络拓扑结构

远程客户机 远程客户机 4 接口规范

4.1 <模块1 API> 描述

<模块功能和设计描述(简要描述)> 集成和部署

<描述模块如何同系统集成，实现形式是DLL, EXE或是嵌入式代码> 4.1.1 Interface1

Function1

string function1(int param1, string param2, …)

param1 - param2 - Function2

string function2(int param1, string param2, …)

param1 - param2 - 4.1.2 Interface2 4.2 <模块2 API> 4.3 <模块3 API> 4.4 <数据库API>

定义数据库存储过程接口

5 模块设计

5.1 Module1设计

<更具具体情况细化模块设计> 5.1.1 模块设计描述 5.1.2 模块界面描述 5.2 Module2设计

6 附录

6.1 第三方组件

Delphi组件

组件名称 版本 用途 .NET组件

组件名称 6.2 参考资料 版本 用途 Design Pattern -

6.3 附加文档 文档名称 项目计划表 数据库定义 *** 文件名 W X****.sql 描述 项目时间规划 数据库定义脚本