详细设计说明书项目管理.docx
《详细设计说明书项目管理.docx》由会员分享,可在线阅读,更多相关《详细设计说明书项目管理.docx(43页珍藏版)》请在冰豆网上搜索。
详细设计说明书项目管理
卷号
卷内编号
文档编号
密级
项目编号:
<正大软件项目管理系统>
普耀科技公司,2007
详细设计说明书
Version:
1.0
项目承担部门:
软件技术一系.NET项目组
撰写人(签名):
杨勇
完成日期:
本文档使用部门:
□主管领导□项目组
□客户(市场)□维护人员□用户
评审负责人(签名):
评审日期:
修订历史记录
日期
版本
说明
作者
2007年7月24日
1.0
起草
杨勇
1.引言4
1.1编写目的4
1.2背景4
1.3定义4
1.4参考资料4
2.综合描述5
2.1系统目标5
2.2运行环境5
2.2.1硬件环境5
2.2.2软件环境5
2.3程序(模块)系统的组织结构5
2.3.1管理子系统代码组织结构5
2.3.2源程序及编译链接组装说明5
2.4界面设计要求6
3.本软件系统中各程序(模块)的设计说明6
3.1程序(模块)1的设计说明7
3.2窗口对象说明表8
3.3程序(模块)2的设计说明8
4.模块相互关系表8
5.待定问题列表9
修订文档历史记录
日期
版本
说明
作者
1.引言
编写目的
根据《软件需求规格说明书》、《概要设计说明书》而书写的《正大软件项目管理系统》详细设计。
供开发人员进行项目开发时使用。
背景
软件系统的名称:
正大软件项目管理系统
本项目的任务提出者:
普耀科技有限公司
本项目的任务开发者:
软件技术一系.NET项目组
软件系统的用户:
正大软件普耀科技有限公司
定义
提示:
列出本文件中用到的专门术语的定义和英文缩写的原词组。
如:
RA(RequestAgent):
服务请求代理;SA(ServerAgent):
服务代理;
Register:
注册管理器;ISMQ(MessageQueue):
消息队列
参考资料
提示:
列出有关的参考资料,主要有以下几项:
本项目的经核准的计划任务书或合同、上级机关的批文;
属于本项目的其他已发表的文件;
本文件中各处引用的文件资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位,以及说明能够得到这些文件资料的来源。
如:
项目管理系统开发计划书(项目管理系统)
软件需求说明书(项目管理系统)
软件测试计划书(项目管理系统)
数据库设计说明书(项目管理系统)
概要设计说明书(项目管理系统)
“WindowsNT设备驱动程序设计指南”,机械工业出版社,1997/12,CIP-23235
“VisualC++6开发使用手册”,机械工业出版社,1999/2,CIP-40581
“TCP/IP进行网际互连”,电子工业出版社,1998/4,ISBN7-5063-4607-5/TP.2188
“研华嵌入式PC平台WindowsCE解决方案”,1999/4
“MFC开发Windows95/NT4应用程序“,清华大学出版社,1998/4
2.综合描述
系统目标
本系统主要用以实现对公司的各类项目进行管理,其中包括:
项目成员管理、客户信息管理、项目信息管理、项目技术管理、日志管理等。
运行环境
硬件环境
数据库服务器:
cpu2.6GHZ以上内存1GB以上硬盘80G以上
客户端台式机配置:
cpu2.6GHZ以上内存512MB以上硬盘60G以上
软件环境
MicrosoftSQLServer2000
MicrosoftvisualStudio2005
IE6.0以上版本
WindowsXP2003以上版本
程序(模块)系统的组织结构
提示:
用层次图表列出本程序系统内各层模块和程序单元的名称(标识符)和它们之间的相互关系。
如:
管理子系统代码组织结构
代码组织结构
代码采用三层结构进行开发,即数据库连接层、业务处理层、应用表现层。
系统部署结构
在服务器端部署服务端程序和数据库。
在客户端通过互联网、IE浏览器进行登录访问。
后台服务程序组织结构
源程序及编译链接组装说明
模块名称
子模块名称
执行程序名
依赖关系说明
依赖源文件
依赖库文件
基本功能管理
用户登录
Login.cs
角色管理
Role.cs
用户信息
User.cs
权限分配
Power.cs
用户注册
Post.cs
密码修改
Modifypass.cs
参数设置
Parameter.cs
日志管理
Journal.cs
项目信息管理
项目信息管理
Iteminfo.cs
项目技术管理
Skillinfo.cs
客户信息管理
Custominfo.cs
项目成员信息管理
成员信息管理
Memberinfo.cs
成员异动管理
Changeinfo.cs
成员考核管理
Examineinfo.cs
查询统计管理
项目基本信息查询
Query_item.cs
客户基本信息查询
Query_custom.cs
成员基本信息查询
Query_member.cs
项目技术信息查询
Query_skill.cs
界面设计要求
提示:
指明总体风格,控件设计标准。
如:
用户界面采用Windows风格,便于用户进行操作。
其控制面板作为操作通话的主要界面,如下图所示:
3.本软件系统中各程序(模块)的设计说明
提示:
在本节中要求按模块依次说明在“2、程序(模块)系统的组织结构”中列出的每个模块的设计内容,包括:
Ø程序(模块)描述,主要说明安排设计本程序(模块)的目的。
Ø程序(模块)功能描述
Ø程序(模块)性能描述
Ø该程序(模块)的输入项
Ø该程序(模块)的输出项
Ø该程序(模块)的算法
Ø该程序(模块)的流程逻辑
Ø接口设计
Ø该程序(模块)的存储分配
程序(模块)1的设计说明
提示:
可采用如下表格方式:
模块详细设计说明表
编号:
xm-01
模块名称
数据库连接
模块代号
Database_conntion.cs
适用范围
全局
类型
自定义类
模块功能
用以实现与数据库的连接、SQL语句运行、调用存储过程以及数据类型的相互转换。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
能够及时地根据相关的sql语句或存储过程名称,获取数据库中的数据,并将数据结果装载到相应的对象里,进行返回。
限制条件
暂无。
输入
传入要执行的sql语句或要执行的存储过程及其对应的参数。
输出
将运行的结果,以数据集、数据读取器等对象的形式进行返回。
算法逻辑
数据库连接对象---sql语句命令对象---执行语句---运行结果装载数据对象---将结果返回。
相关对象及接口
暂无
备注
暂无
编号:
xm-02
模块名称
用户登录模块
模块代号
Login.cs
适用范围
局部
类型
窗口
模块功能
用以实现系统用户的登录,如果登录成功打开系统主界面,登录不成功报“登录失败”提示,如果连续三次登录失败,退出登录窗口,结束该应用程序。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
能够及时根据用户帐号和密码,获取是否登录成功的结果。
限制条件
暂无。
输入
输入系统用户的帐号和密码。
输出
如果登录成功,打开项目管理系统主界面。
登录失败,返回登录失败信息。
对登录成功且未进行角色分配或分配角色未进行权限分配,报“该用户无权使用该系统,与管理员联系”的提示。
算法逻辑
暂无
相关对象及接口
主界面窗口,以及用户权限分配。
备注
记录登录用户的ID号或用户姓名/密码等信息,供其他窗体使用。
编号:
xm-03
模块名称
主窗体
模块代号
Main.cs
适用范围
全局
类型
窗体类型
模块功能
由于本系统是利用B/S结构来实现,在主界面利用树型导航控件来实现各个页面之间的转换。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
通过点击主页面左侧的树型控件的不同节点,在右侧的框架页面及时显示对应页面信息。
限制条件
根据不同的登录用户所对应的角色,对应不同权限的显示节点。
输入
根据登录成功的用户ID,找到其所对应的角色,并根据其角色ID,找到对应可视的树型节点,将主窗体树型控件进行初始化。
输出
符合当前登录成功用户角色的可视化主窗体。
算法逻辑
暂无。
相关对象及接口
登录窗体
备注
暂无
编号:
xm-04
模块名称
角色信息管理
模块代号
Role.cs
适用范围
局部
类型
窗体
模块功能
用以实现本系统登录用户角色的管理,其主要的操作包括:
角色的添加、修改、删除、保存等信息。
为按角色实现系统权限分配奠定基础。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
主要用以实现系统角色的维护,时时、准确地显示当前系统的各种角色。
限制条件
在对角色进行删除时,若该角色下已有登录用户,则不能进行删除。
输入
可对现有角色或新增角色信息进行录入。
输出
将对角色进行增、删、改的操作后,将所的结果保存到数据库中。
算法逻辑
暂无
相关对象及接口
通过主界面来调用该窗体。
备注
暂无
编号:
xm-05
模块名称
用户信息管理
模块代号
User.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现本系统的用户信息管理,包括:
添加新用户、修改用户信息、删除用户信息,为已有用户分配角色等。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
时时、准确显示现有系统的所有用户。
限制条件
暂无。
输入
用户基本信息的输入。
输出
将对用户基本信息进行操作后的结果,保存到数据库中。
算法逻辑
暂无
相关对象及接口
主窗体页面。
备注
暂无
编号:
xm-06
模块名称
权限分配
模块代号
Power.cs
适用范围
局部
类型
窗体类型
模块功能
本模块,是根据已有的系统角色,进行系统的使用权限分配。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
对系统已进行权限分配的角色,时时展示其分配结果。
限制条件
对未进行权限分配的角色,分配初始权限为均不可见。
输入
所要进行权限分配的角色信息。
输出
将对角色进行权限分配的结果保存到数据库中。
算法逻辑
暂无
相关对象及接口
主窗体页面。
备注
暂无
编号:
xm-07
模块名称
用户密码修改
模块代号
Modifypass.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现当前登录用户密码的修改。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
暂无
限制条件
只能对当前使用系统的用户密码进行修改。
输入
用户的原有密码、所要修改的新密码以及确认密码信息。
输出
将修改后的用户密码保存到数据库中。
算法逻辑
暂无
相关对象及接口
主窗体页面。
备注
暂无
编号:
xm-08
模块名称
参数设置管理
模块代号
Parameter.cs
适用范围
局部
类型
窗体类型
模块功能
用树型控件的方式实现系统其他配置参数信息的管理,其中包括:
项目类型、项目组分类、客户类型等,所要完成的基本操作包括:
增加、修改、删除、保存等。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
能够根据树型控件节点的变化,时时显示对应节点的参数内容。
限制条件
当不同节点发生改变后,对已有节点的参数内容发生增、删、改的提醒用户进行保存。
输入
输入对应节点的参数内容。
输出
将进行变化后的参数内容保存到数据库中。
算法逻辑
暂无
相关对象及接口
主界面窗体。
备注
暂无
编号:
xm-09
模块名称
日志管理
模块代号
Journal.cs
适用范围
全局
类型
自定义类、窗体类
模块功能
用以记录当前用户登录系统和退出系统的有关信息,以及当前用户对系统数据库表内容进行了操作的记录(这种操作包括:
数据增加、修改、删除等)。
并能按时间和用户显示日志信息。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
能及时显示给定用户在指定时间段对系统发生的各种操作。
限制条件
暂无。
输入
传入当前用户什么时候对数据库中的哪张表,实行何种操作。
输出
将操作的结果保存到数据库中。
算法逻辑
暂无
相关对象及接口
所有与数据库进行操作的界面。
备注
暂无
编号:
xm-10
模块名称
项目信息管理
模块代号
Iteminfo.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现项目的基本信息管理,包括:
新增项目信息、修改已有项目信息等。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
及时显示系统中,正在进行的项目信息。
限制条件
在展现项目信息时,对过期或暂停的项目暂不显示。
。
输入
对项目的基本信息进行输入。
输出
将进行变动的项目信息保存到数据库中。
算法逻辑
暂无。
相关对象及接口
主窗体页面。
备注
暂无
编号:
xm-11
模块名称
项目技术管理
模块代号
Skillinfo.cs
适用范围
局部
类型
窗体类型
模块功能
记录特定项目的关键技术,主要的操作包括:
关键技术的录入、修改、删除以及保存等。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
及时显示指定项目的关键技术。
限制条件
暂无。
输入
按项目分类,选择所需要维护的项目名称,并在指定的项目下,实现该项目关键技术的维护(包括:
技术的新增、修改、删除等操作)。
输出
将给定项目的关键技术进行变更的结果保存到数据库中。
算法逻辑
暂无。
相关对象及接口
主窗体页面、项目基本管理模块。
备注
暂无
编号:
xm-12
模块名称
客户信息管理
模块代号
Custominfo.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现对客户的基本信息进行维护和管理,其主要的操作包括:
客户基本信息的新增、修改、删除以及保存等。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
能时时提取或保存客户信息。
限制条件
暂无。
输入
输入客户的基本信息。
输出
将进行变更的客户信息保存到数据库中。
算法逻辑
暂无
相关对象及接口
主页面窗体
备注
暂无
编号:
xm-13
模块名称
成员信息管理
模块代号
Memberinfo.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现系统中项目组成员的基本信息,进行管理,其主要的操作包括:
成员信息的新增、修改、删除以及保存等。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
时时显示和保存项目组成员的基本信息。
限制条件
暂无。
输入
进行项目组成员基本信息的录入。
输出
将变更后的项目组成员信息保存到数据库中。
算法逻辑
暂无
相关对象及接口
主页面窗体
备注
暂无
编号:
xm-14
模块名称
成员异动信息管理
模块代号
Changeinfo.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现项目组成员的异动信息的管理,这种异动信息包括:
职位升迁、部门调动、入职、离职等。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
能够时时准确显示项目组各个成员的异动信息。
限制条件
暂无。
输入
项目组成员的异动信息。
输出
将项目组成员的变迁信息保存到数据库中,以供查询和维护。
算法逻辑
暂无
相关对象及接口
主页面窗体、成员信息管理
备注
暂无
编号:
xm-15
模块名称
成员考核管理
模块代号
Examineinfo.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现对项目组成员的工作业绩的考核。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
暂无
限制条件
暂无。
输入
输入项目组成员、考核类型、考核结果等信息。
。
输出
将对成员考核的结果保存到数据库中。
算法逻辑
暂无
相关对象及接口
主页面窗体
备注
暂无
编号:
xm-16
模块名称
项目基本信息查询
模块代号
Query_item.cs
适用范围
局部
类型
窗体类型
模块功能
给定时间段或项目类型,查询项目的基本信息。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
暂无
限制条件
暂无。
输入
要进行查询的时间段或要进行的查询的项目类型。
输出
将查询结果展现出来,或进行打印成报表。
算法逻辑
暂无
相关对象及接口
主页面窗体、项目基本信息管理
备注
暂无
编号:
xm-17
模块名称
客户基本信息
模块代号
Query_custm.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现客户的基本信息的查询,可以按客户的类型等信息进行条件查询。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
查询速度在5<=秒内完成。
限制条件
暂无。
输入
输入客户类型等信息。
输出
将查询结果展现出来,或将结果打印出来。
算法逻辑
暂无。
相关对象及接口
主页面窗体、客户基本信息管理窗体
备注
暂无
编号:
xm-18
模块名称
成员基本信息查询
模块代号
Query_member.cs
适用范围
局部
类型
窗体类型
模块功能
实现系统成员基本信息的查询,可以按项目成员的基本类型,项目成员承担的角色等信息进行查询。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
查询速度在5<=秒内完成。
限制条件
暂无。
输入
项目成员的基本类型等信息
输出
将查询结果显示出来,或进行打印。
算法逻辑
暂无。
相关对象及接口
主页面窗体、项目成员基本信息管理窗体。
备注
暂无
编号:
xm-19
模块名称
项目技术信息查询
模块代号
Query_skill.cs
适用范围
局部
类型
窗体类型
模块功能
用以实现具体的项目技术信息查询,可以按项目、项目类型或项目技术类型等进行查询。
作者
杨勇
编写时间
2007-7-25
修改人
修改时间
修改批准人
修改次数
性能要求
查询速度在5<=秒内完成。
限制条件
暂无。
输入
项目名称或编号、项目类型或项目技术类型等信息。
输出
将查询的结果显示出来或打印出来。
算法逻辑
暂无
相关对象及接口
主页面窗体、项目技术管理窗体
备注
暂无
提示:
若本模块是一个窗口,还需填写窗口对象说明表。
窗口对象说明表
窗口对象说明表
编号:
xm_wd_01
窗口名
登录窗体
说明书编号
1、窗口对象控件列表
对象类型
对象名称
对象事件
对象功能描述
用户使用控制
文本输入框
Txt_usercode
Txt_usercodechanged()
当用户输入帐号后按“回车”键时触发。
针对不同用户,设置不同的操作权限
文本输入框
Txt_password
Txt_passwordchanged()
当用户输入密码按“回车”键时触发。
按钮
Btn_ok
Btn_okOnclicked()
进行帐号和密码验证时触发。
按钮
Btn_cancled
Btn_cancledOnClicked()
退出登录窗口时触发。
2、窗口事件(函数)列表
事件(函数)名
事件(函数)
类型
事件(函数)功能描述
事件(函数)算法逻辑
暂无
编号:
xm_wd_02
窗口名