XXX公司软件开发设计文档

　XXX 公司 软件开发设计文档

　 文档管理信息表

　主题

　 版本

　 内容

　 关键字

　 参考文档

　 创建时间

　 创建人

　 最新发布日期

　 文档变更纪录

　更改人

　日期

　更改内容

　创建文件

　文档 主要 评审意见

　 产品组 评审人员

　日期

　意见

　 QA 组 评审人员

　日期

　意见

　目

　录

　 1 1 开发规划

　................................ ......

　1 1 1.1 开发人员 .................................... 1 1.2 开发计划 .................................... 2 1.3 开发环境和工具 .............................. 3 1.4 开发规范 .................................... 3 2 2 总体设计

　................................ ......

　4 4 2.1 概念术语描述 ................................ 4 2.1.1

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

　2.1.2

　术语 2 .................................... 4

　2.2 基本设计描述 ................................ 5 2.2.1

　系统总体逻辑结构图 ........................ 5

　2.2.2

　系统部署结构图 ............................ 6

　2.3 主要界面流程描述 ............................ 7 2.3.1

　功能 1 界面流程 ............................ 7

　2.3.2

　功能 2 界面流程 ............................ 7

　2.4 模块列表 .................................... 8 3 3 数据结构

　................................ ......

　9 9 4 4 接口规范

　................................ .....

　10 4.1 <模块 1

　API> ................................ 10

　4.1.1

　Interface1 ............................... 10

　4.1.2

　Interface2 ............................... 10

　4.2 <模块 2

　API> ................................ 11 4.3 <模块 3

　API> ................................ 11 4.4 <数据库 API> ................................ 11 5 5 模块设计

　................................ .....

　12 5.1 M ODULE 1 设计 ................................. 12 5.1.1

　模块设计描述 ............................. 12

　5.1.2

　模块界面描述 ............................. 12

　5.2 M ODULE 2 设计 ................................. 13 6 6 附录

　................................ .........

　14 6.1 第三方组件 ................................. 14 6.2 参考资料 ................................... 15 6.3 附加文档 ................................... 15

　开发规划

　开发 人员

　 角

　色

　主要 职责

　负责 模块

　人员

　备注

　项目经理 PM

　项目全面负责 项目设计 主要框架/模块编写 项目进度控制 XXXXXXXXX模块 XXXXXXXXX

　产品经理 PT 定义需求 产品监督 结果验证（测试）

　用户文档 无 XXXXXXXXX

　程序员 DEV

　XXXXXXXXX模块 XXXXXXXXX

　程序员 DEV

　XXXXXXXXX模块 XXXXXXXXX

　开发计划

　 <附开发计划表>

　开发环境和工具

　 开发工具 工具

　作用

　Delphi 7 .net 客户端 VBA 开发 EXXXcel 插件 VS.NET Web 页面，Web Service

　 开发规范

　文档名称

　位置

　Delphi 编码规范

　系统目录规范

　总体设计 概念术语描述

　 术语 1 <术语 1 的描述>

　术语 2 <术语 2 的描述>

　基本设计 描述

　 <文字性的设计思路>

　系统总体逻辑结构图

　模块 1 模块 2 模块 3 层/包 1

　 模块 1 模块 2 层/包 2

　系统部署结构图

　数据库服务器 Web 服务器 防火墙 内部客户机 内部客户机 VPN/ INTERNET 远程客户机 远程客户机 系统网络拓扑结构

　主要界面 流程 描述

　功能 1 界面流程

　功能 2 界面流程

　模块 列表

　模块名称( ( 英文) )

　功能

　备注

　模块 1 Module1

　 模块 2 Module2

　 模块 3 Module3

　 数据结构

　数据库表列表 表名

　作用

　 <附 SQL 数据库结构定义文档>

　接口规范

　< < 模块 1 API> >

　 描述

　<模块功能和设计描述(简要描述)>

　集成和部署

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

　Interface1 <interface1 description>

　Function1 string function1( int param1, string param2, …) )

　<function1 description> param1 - <param1 description> param2 - <param2 description>

　Function2 string function2(int param1, string param2, …) )

　<function2 description> param1 - <param1 description> param2 - <param2 description>

　 Interface2

　< < 模块 2 API> >

　 < < 模块 3 API>

　< < 数据库 API> >

　 定义数据库存储过程接口

　模块设计

　 1 Module1 设计

　 <更具具体情况细化模块设计>

　模块设计描述

　模块界面描述

　2 Module2 设计

　附录 第三方组件

　 Delphi 组件 组件名称

　版本

　用途

　.NET 组件 组件名称

　版本

　用途

　参考 资料

　 Design Pattern -

　附加文档

　 文档名称

　文件名

　描述

　项 目 计 划表 Wind.net.plan.mpp 项目时间规划 数 据 库 定义 XXXXXXXXX.sql 数据库定义脚本 XXX