软件项目开发文档格式.docx
《软件项目开发文档格式.docx》由会员分享，可在线阅读，更多相关《软件项目开发文档格式.docx（38页珍藏版）》请在冰豆网上搜索。
目前国内各大后勤资产管理系统所提供的主要功能有，用户注册，删除用户，修改用户，仓库管理，物资采购，修改物资信息，删除物资信息，物资入库，物资出库，物资盘点，财产管理，房屋管理，耗材管理，数据备份，系统初始化。
但考虑到开发时间和人力资源的具体情况，后勤资产管理系统只是初步实现其中的核心功能，去除了一些超出自己能力范围的一些内容。
后勤资产管理系统是企业内部很重要的一个管理事项，但目前企业内的管理，基本上是手工操作或是基于dos下的应用，这样对信息的管理者有诸多不便，有的系统对网络功能的支持程度不是很强，为以后软件升级到互联网带来了麻烦。
因此有必要开发一个完全基于网络的管理系统，能在网络环境下实现数据的录入、插入、删除、查询、统计、更新、等功能。
实现数字化管理。
项目开发的可行性
本系统采用JSP，Struts，Hibernate等技术开发，实现一次编写，到处运行。
系统的多平台支持。
基本上可以在所有平台上的任意环境中开发，在任意环境中进行系统部署，在任意环境中扩展。
强大的可伸缩性。
从只有一个小的文件就可以Servlet/JSP，到由多台服务器进行集群和负载均衡，到多台Application进行事务处理，多样化和功能强大的开发工具支持。
这一点与ASP很像，Java已经有了许多非常优秀的开发工具，而且许多可以免费得到，并且其中许多已经可以顺利的运行于多种平台之下。
Struts是实现MVC模式的通用框架，它由四个主要部分组成，模型、视图、控制器和XML文件。
模型通常由JavaBean或EJB组件实现，负责处理业务逻辑；
视图包括一组JSP文件，这些文件主要由JSP标签或客户化标签构成，它简化了JSP页面的编码工作Hibernate是一种实现对象和关系之间映射（ObjectRelationMapping）的框架。
它对JDBC进行了轻量级的对象封装框架Struts+hibernat应用于Web页面开发，有着很强的优势；
而Mysql对于中小型的系统来说，是个很好的选择,对一些企业或单位不需要大型的数据库系统就可以用我们的系统。
我们结合MVC和本系统的具体特点，把系统分为四个层次：
页面表示层，业务逻辑层，数据处理层。
Hibernate用来处理数据库的连接，Struts用于逻辑处理。
完整的开发技术给系统带来了很大可使用性。
结合在乔不斯软件公司培训的经验和技术加强实现后勤管理系统的开发工作可行。
随着计算机的发展与普及，以及互联网技术的扩展，日常劳资人事管理必将实现无纸化办公，并且加入到公司内部的Intranet或者是Internet上去，实现数据的共享，这样有管理信息在单位内部的查询，提高了管理的公正和客观性，并且能及时的得到更新，不需要象过去那样浪费大量的人力物力去进行抄写，提高了工作的效率。
2.项目开发计划书
项目组织
项目资源
人力资源
姓 名
性别
部门（班级）
在本项目中承担的工作
男
重信院06级软技六班
组长
成员
已有开发设施
开发地点：
重庆信息技术职业学院
使用硬件：
电脑4台、U盘一个
使用软件：
Myeclipse、MySQL、SVN、
需获取的设施
打印机
实施计划
项目开发过程阶段划分
阶段名称
起止时间
工作内容
阶段产品
项目开发计划
2008年9月20日
让各成员明确自己的职责以及了解整个项目进度的安排
《项目开发计划》
需求分析
2008年9月22日至27日
《需求分析文档》
概要设计
2008年10月01日至10日
以结构化的设计设计为主，画出系统总体结构图，列出系统的功能模块清单编号、名称、功能，并尽可能描绘出功能模块之间的关系。
《概要设计文档》
《数据库设计文档》
详细设计
2008年10月10日至25日
《详细设计文档》
编码
2008年11月16日至12月15日
实现设计中所有的功能
程序代码
结项
2008年12月22日
《项目开发总结报告》
项目工作任务分解
任务项
参加人员
交付项、应提交文档
计划
蒋朝伟、高才、刘宁、金学成
《需求规格说明书》
界面原型
分析设计
《概要设计说明书》
《数据库设计说明书》
蒋朝伟、高才、刘宁
《详细设计说明书》
编码
程序
蒋朝伟、高才、刘宁、金学成
联系人员*
联系人员：
联系方式：
联系地址：
重庆信息学院软件一系
3.需求分析
软件描述
开发背景
后勤资产管理系统是企业内部很重要的一个管理事项，它对企业的发展起着非常举足轻重的作用，但目前企业内的管理，基本上是手工操作或是基于dos下的应用，这样对信息的管理者有诸多不便，有的系统对网络功能的支持程度不是很强，为以后软件升级到互联网带来了麻烦。
后勤资产管理系统（B/S体系架构），需要实现当前各大后勤资产管理系统所提供的各种主要功能。
由于物资的种类繁多，在各部门进出频繁，使得物资管理变得十分复杂。
开发一套完善的资产管理系统不但可以使物资的管理者能够对物资的整个流程状态、库存状况了如指掌，并为决策管理提供科学依据，从而提高了管理水平和工作效率，而且可以使工作人员甩掉手工记账方式，从而最大限度地减少了手工操作带来的失误，达到事半功倍的效果。
软件功能
表4-1功能需求表
01
用户管理
Sys
高
管理用户
02
修改用户
ModifySys
中
修改用户信息
03
删除用户
dels
04
添加用户
appendUser
添加新用户
06
仓库管理
ckManage
管理仓库
07
物资入库
findRuku
将采购的物资入库
08
物资出库
delchuku
将需要的物资出库
09
物资管理
viewProduct
管理物资
10
采购管理
cgManage
11
采购申请
cgshenqing
采购物品申请
12
采购审批
shenpiList
审批已采购物品
13
财产管理
ccshenqing
14
财产申请
getUse
申请财产
15
财产审批
examine
审批已申请财产
16
房屋管理
fwManage
用户的特点
后勤资产管理系统主要是面向后勤部门，他们对网上管理系统的熟悉有限，要求开发的系统简单易懂，操作方便，快洁。
因此，用户的跨度比较小，只要懂得计算机的基本操作就可以利用该软件进行操作。
限制与约束*
本系统开发人员大多数无实际开发验，属于边学边开发。
另外本次开发属于开发实训。
由于开发时间，人力资源等问题，本小组暂为对用例分析中的某些用例在功能上进行实现。
系统只解决了一些主要的用例。
功能需求
系统管理
1.备份/还原数据库
备份数据库内表中的所有数据到指定地址。
需要时（数据崩溃等）从指定的备份数据库中还原备份时的数据。
2.用户管理
修改密码：
修改用户的初始密码，并保存到数据库中。
添加用户：
添加需要的用户。
删除用户：
删除多余或禁用的用户。
3.系统初始化
数据库崩溃或数据库中沉余信息太多等，需要清楚数据库中数据。
1.仓库信息管理
呈现仓库的全部属性，可以修改仓库属性。
2.入库管理
采购后需要把物资存入仓库中，此处把进入仓库中的物资逐一进行登记。
3.出库管理
部门的领用、借用、调用等，要从仓库中去出物资，并记录。
4．物资管理
仓库物资汇总。
财产管理
1．采购管理
采购申请：
当公司需要某中物资而仓库中没有，到外购买时需要提交采购申请，生成采购申请单。
采购审核：
当采购部门递交申请单上来时，由用户审核。
通过则购买该申请单上的物品并保存至仓库中，同时将该申请单备注为以审核。
否则，删除该申请单，取消购买。
2．领用管理
领用申请：
当某部门需要某物资时，需要向上提交申请单，申请该物资。
领用审核：
审核领用申请单，通过则从仓库去出该物资转入部门库存中，修改仓库中该物资的库存数量，增加部门该物资的库存量。
3．借用管理
借用申请：
公司某人需要某物，向部门借用物品需提交借用申请单，等待审核通过才能借用。
借用审核；
审核借用申请单，通过则从部门库存中去出该物品减少库存数量，生成借用单据。
等待归还。
房屋管理
1.房屋配置信息
罗列房屋中的各种物资记入仓库中。
2.宿舍管理
教室宿舍管理：
管理教室宿舍的分配和宿舍中物资的信息。
办公室管理：
管理办公室中物资的信息。
学生宿舍管理：
管理学生宿舍的分配和宿舍中物资的信息。
性能需求
例如：
（1）系统可靠性和安全性
对系统（应用系统和数据库）应该设计尽可能详尽的故障处理方案，以保证系统的快速恢复性。
并采用冗余技术保证数据可靠存储、系统可靠运行。
对系统运行状况采用自动检测、告警、监控等方式进行实时观测。
在系统使用过程中，由于硬件出现故障或其它原因造成系统暂时性的中断后系统重新启动时，能够保证系统将原有的数据快速恢复，使其继续运行下去。
为确保系统的安全性，系统采取应用系统使用验证（操作员验证）、数据库登陆验证两种验证方式相结合的方法验证用户。
运用日志，对进入系统的用户的操作进行记录,可以根据日志进行事后分析，从而找到事故的发生原因、责任者或非法用户。
（2）系统的开放性和系统的可扩充性
系统在开发过程中，应该充分考虑以后的可扩充性。
例如，用户查询的需求会不断地更新和完善。
所有这些，都要求系统提供足够的手段进行功能的调整和扩充。
而实现这一点，应通过系统的开放性来完成，即系统应是一个开放系统，只要符合一定的规范，可以简单地加入和减少系统的模块，配置系统的硬件。
通过对软件的修补、替换，完成系统的升级和更新换代。
（3）系统的易用性和易维护性
系统是直接面对使用人员的，而使用人员往往对计算机并不是非常熟悉。
这就要求系统能够提供友好的用户界面，易用的人机交互界面。
要实现这一点，就要求系统应该尽量使用户熟悉的术语和中文信息的界面；
针对用户可能出现的使用问题，要提供足够的在线帮助，缩短用户对系统熟悉的过程。
系统中涉及到的数据是我们统计中相当重要的信息，系统要提供方便的手段供系统维护人员进行数据的备份、日常的安全管理、系统意外崩溃时数据的恢复等工作。
（4）系统的标准
系统在设计、开发、使用过程中，要涉及很多计算机硬件、软件。
所有这些都要符合主流国际、国家和行业标准。
例如，在开发中使用的操作系统、网络系统、开发工具都必须符合通用标准。
运行环境及外部接口需求
（1）硬件要求
客户程序硬件要求：
具有PentiumIII处理器且满足以下要求的计算机：
最低64MB内存、最小GB硬盘、鼠标、键盘
服务器硬件需求：
最低256MB内存、最小8GB硬盘、鼠标、键盘
（2）软件要求
客户程序软件：
WindowsXP或更高版本
服务器软件：
Windows2003或更高版本、MySQL、、
（3）用户接口
采用Windows的通用图形界面，用户友好。
②界面具有一致性，界面规范遵循Windows软件界面的规范。
③提供错误处理。
④提供多种信息提示当前用户的状态、界面。
⑤提供方便的联机帮助。
⑥遵循国家关于计算机方面词汇的标准，用词正确、准确、无歧义。
⑦本系统的用户一般需要通过中断进行操作，进行主界面后点击相应的窗口，分别进入相对应的界面（如，输入界面、输出界面）。
设计约束*
1、遵循标准的报表格式，公司统一的数据命名规则；
2、计算机的硬件限制；
3、操作系统环境的限制，Windows2000以上操作系统。
4.概要设计
软件体系结构
本软件使用B/S的三层构架。
软件程序结构图
模块命名规则
以模块名称每个字拼音的首字母连接而成。
编号
名称
模块标识
1
系统初始化
XTCSH
2
YHGL
3
数据库备份/还原
SJKBF
4
仓库信息管理
CKXXGL
5
WZRK
6
WZCK
7
WZGL
8
CGGL
9
领用管理
LYGL
借用管理
JYGL
房屋配置信息管理
FWPZXXGL
FWGL
可复用资源
公共类：
1,数据库连接；
2,数据类型转换；
3,中文处理；
4,数据备份；
5,时间处理；
5.详细设计
详细设计是我们软件开发流程终不可或缺的一部分，它是在概要设计的基础上，对概要设计的每个功能模块进一步细化。
系统管理
功能结构图
图5-1-1系统管理结构图
业务逻辑图*
图5-1-2系统管理流程图
功能项描述
功能项
标识
子系统
用户管理系统
功能描述
添加、删除用户。
使用角色
高级管理人员
主要事件流程
用户操作
系统响应事件
单击增加按钮
数据库新增货物单
单击删除按钮
数据库删除相应的货物单。
单击查询按钮
显示相应符合查询条件的值
单击修改按钮
修改数据库相应的货物单数据
单击清空按钮
清空填写的表单
异常事件
用户确认信息
提示相应的错误信息
前置条件
用户登陆系统并具有相应的权限
后置条件
数据库有相应的改变
接口说明
输入
输出
调用关系
调用模块
被调用模块
界面设计图
功能结构图
业务逻辑图
功能项描述
对物资进行删除，修改；
查看仓库入库信息和出库信息
普通管理员，后勤资产管理员。
修改物资信息
删除物资信息
用户确认修改信息
确认已修改的物资信息
界面设计图
申请，审核物资
LYGL、JYGL
申请采购、领用、借用物资，产生申请单，由管理员审核。
采购员，部门其他人员，管理员
单击领用按钮
领用物资
单击借用按钮
借用物资
用户确认物资信息
图5-4-1房屋管理功能图
图5-4-2房屋业务图
添加房屋管理
房屋管理员，后勤资产管理员。
添加房屋信息和房屋使用者信息。
查询房屋使用状态
用户确认房屋信息
执法人员档案管理
6.数据库设计
外部设计
标识符和约定
（1）表名：
表全名
例如：
物资领用表：
WZLY
注：
表全名可根据表名实际的长短情况而定.如上的物资领用表的表全名就为WZLY。
（2）字段名：
表名前两字母＋字段名
区域名称：
lywsl
表类型划分
主表:
系统用户表，仓库入库信息表,物资信息表,仓库出库单信息表、物品信息表，物资领用表，物资借用表，物资申请单据表，采购申请表等
辅助表:
系统权限表,部门信息表,部门财产登记表等,
安全保密设计
数据库设计对数据库的用户分配了不同的登录角色.所有角色都进行了登录权限的设置.登录人员根据最高管理员（由各使用单位安排,该人员具有对数据库的最高操作权限）分配的登录名与密码进行登录.使用错误的登录名或登录密码无法登录该数据库.一般用户登录拥有修改自己个人资料的权限，只有最高管理人员具有对数据库的添加,删除,修改,备份,恢复等操作.数据库的备份功能体现了安全性.定期对数据库进行自动备份,一旦数据库毁坏,进行数据库恢复,可以找回原来的数据.
支持软件
（1）MYSQL:
可用于管理数据库的数据。
（2）PowerDesigner以上版本）:
用于对数据库概念模型及物理模型的设计,用于装入,修改,生成,更新数据库。
数据库表设计格式说明
表6-1用户管理表
表名
sysusers
描述
系统用户信息表
数据项名称
字段名称
数据类型
为空
主外键
备注
流水号
id
int（10）
否
主键
操作员编号
uid
varch1ar（10）
操作员姓名
username
varchar（32）
用户口令
password
varchar（10）
sex
年龄
age
int
所在部门
bm
varchar（100）
联系方式
phone
密码提示问题
question
提示问题答案
answer
用户邮件
email
varchar（50）
用户权限
qx
varchar
（2）
状态
zt
varchar（5）
bz
varchar（500）
表6-2用户权限表
userqx
系统权限表
权限编号
uqid
varchar（16）
权限名称
uqname
权限备注
uqbz
表6-3物资入库信息表
ck_ckxx
仓库入库信息
int（11）
仓库编号
ckid
物品编号
wpid
物品名称
wpname
varchar（30）
物品数量
wpnumber
物品单价
wpdanjia
float（10,2）
物品规格
wpguige
物品单位
wpdanwei
升级会员 