第 11 章 项目规划与设计文档
本章要点:
◎从零开始介绍一个电子商务项目的规划,设计、测试和发布
◎介绍项目通用文档的格式和编写
◎重点介绍需求分析说明书,概要设计说明书,详细设计说明书,测试计划,发布说
明书和项目进度管理说明书的格式和编写
11.1 需求概述
某公司需要在近期开展网上商务,需要开发一个电子商务项目,该项目包括两个部
分:网上书店系统和书店后台管理系统。
网上书店系统需要的功能为:1、用户注册功能;2、用户登录功能;3、图书分类购
买;4、购物车;5、网上下订单;6、后台管理功能;7、用户管理;8、类别管理;9、
书籍管理;10、订单管理。(实现代码见光盘/11/shop)
11.2 通用页面编写
在项目的开发过程通常要写大量的文档,B/S 架构的开发文档和非 B/S 架构的开发文
档区别很大,B/S 架构需要编写需要区分前台和后台,也就是要将客户端和服务器端分开
编写。
在项目开发过程中,一般编写文档时间占总工作量的 50%-60%。文档是否完善是评
估一个项目的重要标准。所有的文档虽然内容不同,但是前两页的结构都是大致一样的。
文档的首页可以作为封皮,其结构为:
XXXX 项目 XXX 说明书
文档编号:
文档信息:XXX 项目开发组开发文档
文档名称:
文档类别:项目开发文件
密 级:内部
版本信息:0.1
建立日期:YY-MM-DD
创 建 人:小张
审 核 者:
批 准 人:
批准日期:
保 管 人:
存放位置:组内服务器
编辑软件:Microsoft Office 2003 中文版
第一页主要是文档的一些描述性信息,后面所有文档第一页都是这样的格式,只是
题名有所变化。第二页是文档的变更记录和审批记录,所有人对于文档的修改和审批都
需要记录,第二页的结构为:
文档修改信息:
版本 *变化状态 简要说明 日期 变更人 批准日期 批准人
1.0 C YY-MM-DD 小张 YY-MM-DD 小李
1.1 M YY-MM-DD 小刘 YY-MM-DD
*变化状态:A——增加,M——修改,D——删除,C——创建
文档审批信息:
序号 审批人 角色 审批日期 签字 备注
001 小李 项目经理 YY-MM-DD 小李
两个通用页面是所有文档的第一页和第二页。签订项目合同之后,需要依次建立的
文档。按照建立时间的先后分别为:需求采集计划书、需求设计说明书、页面需求设计、
开发计划书、程序概要设计、数据库概要设计、页面详细设计、数据库详细设计、后台
脚本详细设计、页面测试说明书、开发总结性报告和后台管理使用手册。
可以根据实际的开发过程,进行增加和删除。也可以根据开发过程,对部分文档进
行合并。
11.3 系统分析
在系统分析阶段,需要对系统进行调研,并制定相应的开发计划。这个阶段需要对
应用程序和数据库结构进行概要设计,并编写相关的文档。
11.3.1 需求采集计划书
需求采集计划书主要功能是确立用户对各个模块的要求,弄清楚用户对系统的要求。
完成过程由部分开发人员到对方单位进行调研,充分和用户交流,明确系统将要实现的
功能。计划书的格式如下:
1.引言
1.1 目的
为了更好地顺利完成本项目的需求采集工作,特制定此需求采集计划,便于对需求和进度进行监督
和控制。
1.2 背景
本项目由××公司提出,由××公司的开发部进行开发,××部门对整个项目的进度进行监督。
1.3 关键字
网上书店,购物车,竞标系统
1.4 参考资料
《项目开发合同》
2.人员及分工说明
资源与分配 开 始 时 间 完 成 时 间 工 时
准备工作 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
商品部分需求采集 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
订单部分需求采集 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
购物部分需求采集 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
后台管理部分需求采集 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
需求测试 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
需求整合确认 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
准备工作 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
商城技术需求采集 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
24
3.采集项目进度预估
开始日期:YY 年 MM 月 DD 日
结束日期:YY 年 MM 月 DD 日
标识号 任务名称 工期 开始日期 结束日期 前置任务 承担人
1
需求设计 7 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日 小周
2
准备工作 1 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日 小王
3
商城需求采集 3 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
2
小李
4
商品需求采集 1 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
2
小陈
5
订单需求采集 1 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
4
小张
6
购物需求采集 1 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
5
小陈
7
后台需求采集 1 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
6
小李
8
需求测试 1 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
7
小李
9
需求整合确认 1 工作日 YY 年 MM 月 DD 日 YY 年 MM 月 DD 日
8
小李
4.需要配合的部门
市场部,提供客户资料,必要时帮助联系客户。
11.3.2 需求设计说明书
需求设计说明书需要对软硬件环境进行说明,将系统功能划分成具体的模块,并对
每个模块进行说明。对系统的性能进行简单的描述,并给出关键模块的处理流程。
1.引言
1.1 编写目的
为了更好地记录、分析、描述用户提出的技术需求,特编写此技术需求设计说明书。同时更好地指
导编辑的页面需求采集工作。
1.2 项目背景
本项目由××公司提出,由××公司的开发部进行开发,××部门对整个项目的进度进行监督。
1.3 参考资料
《开发合同》《需求采集计划书》
2.技术概述
2.1 目标
使用 ASP.NET 和 SQL Server 技术,将系统做成界面友好,用户购物方便,编辑管理产品方便的购
物系统和网上竞标系统。
2.2 硬件环境
采用用户已有的硬件环境即可。
2.3 软件环境
因为采用 ASP.NET+SQL Server 技术,所以对允许软件没有特殊。操作系统可以是 Windows 2000,
也可是 Windows 2003。
3.数据描述
3.1 已有数据
用户已有产品数据、商品数据作为基础数据需要导入数据库中。所有这些数据都是电子文档。
3.2 录入数据
需要编写后台的商品、产品、文章等录入程序。
3.3 数据保存
数据一律保存在数据库中。
3.4 数据词典
产品:即数据库中所有的产品。
商品:用于销售的产品。
3.5 数据采集
需求采集人员向用户收集相关产品信息。
4.功能需求
4.1 功能划分
系统共分两个部分,一部分是面向用户的部分,用户可以在线注册、购物、提交订单等操作;另外
一部分是系统管理部分,这部分的内容包括:产品添加、删除、查询、订单管理、操作员管理、注册用
户管理等。
4.2 功能描述
4.2.1 面向用户功能:
(1)注册功能。消费者首先要注册为系统的用户。注册时只要填写登录用户名、密码、联系电子
信箱 3 项信息即可。注册后,用户可继续填写详细个人信息及收货人信息,同时可修改密码、查询及维
护订单。
(2)选择产品功能。消费者浏览系统,将自己需求的产品放入到购物车中(可在网上商城首页、
专柜首页、产品小类、专卖店首页、搜索结果页面、产品详细信息页面进行该操作),可连续添加商
品。
(3)管理购物车。消费者选择完商品后可进入购物车页面,查看自己要购买的商品,可修改某一
商品数量、取消购买某商品和清空整个购物车。
(4)订单功能。消费者确定购物车中的商品后提交订单,如消费者已填写收货人信息,则页面显
示该信息并由消费者确认。如尚未填写则显示相应表单请其填写,系统记录消费者提交的收货人信息以
便其下次购物时使用。消费者提交订单后可在系统查询该订单,并可对尚未处理的订单进行取消、修改
等操作。
(5)补充说明。消费者可先登录后购物,也可先浏览系统,将商品放入购物车中,在提交订单时
系统提示其登录(新用户要先注册)。
4.2.2 后台管理部分功能
(1)管理用户功能。用户分为两级,管理员和基本用户。基本用户分为编辑、专卖店负责人、消
费者 3 类。不能自己注册,一律由最高管理员添加。编辑拥有基本用户的最高权限,可访问所有订单,
可浏览、增、删、改、查订单,可维护订单状态。专卖店负责人只具有处理本店订单的权限,同样可浏
览、增、删、改、查订单,可维护订单状态。
(2)管理订单功能。消费者可通过 Web 方式取消、修改自己提交的订单(确认前),查询自己提
交的订单(随时)。如订单的状态在一定时限(如 24 个小时)后仍没有变化(“订单关闭”状态除外),
系统自动提醒专卖店负责人及网店编辑(如该订单变色,弹出提醒窗口等方式。订单状态发生变化,系
统自动发 E-mail 给消费者,“无效订单”、“订单关闭”状态除外)。
(3)管理商品功能。商品由编辑添加、删除和修改。
(4)管理文章功能。应该有文章的添加、删除和修改的功能。
5.性能需求
5.1 数据精确度