OA系统需求文档

附录1 阶段项目文档要求
OA系统这个比较大，每组
只用做其中的一个子模
块：人事管理、日程管
理、文档管理这三个子模
块其中的一个
阶段项目要求每个项目小组完成的文档包括以下内容。

➢需求和需求分析说明书：需求描述和主要的用例图，参见下面的“系统需求和需求分析说明书模板”。

➢系统设计说明书：系统主要的实例类图，至少3个用例的时序图，参见下面的“系统设计说明书模板”。

➢单元测试用例：至少记录3个单元测试的测试用例，参见下面的“测试用例模板”；
➢阶段答辩：答辩用的幻灯片，幻灯片的内容要求参见下面的“答辩用的幻灯片的目录结构”。

➢其他：项目进度安排表（由项目经理或小组长提供），参见下面的“项目进度安排表模板”。

北大青鸟Aptech提供给教员的资源包括。

➢项目需求和需求分析说明书电子文档。

➢系统设计说明书电子文档。

➢项目进度安排表模板电子文档。

➢测试用例模板电子文档。

➢数据库脚本和完整源代码。

说明：Java和.NET编码规范请参看第一阶段和第二阶段的相关课程。

最后一点是文档模板和样式。

附1.1 系统需求和需求分析说明书模板
系统需求和需求分析说明书
版本历史
第一部分概述
1．项目名称及背景
➢项目名称
➢开发背景
2．文档说明
第二部分任务说明
1．功能概述
2．用户环境
浏览器(如IE 6以上版本)+网络
开发(生产)环境:
第三部分需求分析
1．实现功能
➢系统用例图
用户业务逻辑如下图所示：
➢管理员功能清单
功能编号功能名称文中标题编号备注101 人事管理
101001 部门管理
101002 员工管理
➢普通用户功能清单
2．用例说明➢ [用例1] ●用例图
●描述
●参与者
➢[用例2] ●用例图
●描述
●参与者
➢[用例3]
●用例图
●描述
●参与者
➢[用例4] ●用例图
●描述
●参与者
➢[用例5] ●用例图
●描述
●参与者
➢[用例6 ●用例图
●描述
●参与者
➢[用例7] ●用例图
●描述
●参与者
➢[用例8]
●用例图
撤消删除
回收站
彻底删除
●描述
回收站：显示被删除的文件，可以撤消删除，也可以彻底删除文件。

●参与者
//*参与者，参与用例的对象*// ➢[用例9]
●描述
文件搜索功能：可以按条件查询需要的文件。

●参与者
//*参与者，参与用例的对象*// ➢[用例10]
●用例图
●描述
●参与者
➢[用例11] ●用例图
●描述
●参与者
➢[用例12] ●用例图
●描述
●参与者
➢[用例13]
●用例图
●描述
●参与者
➢[用例14]
●用例图
●描述
●参与者
3．用例关系
附1.2 系统设计说明书模板
系统设计说明书
版本历史
第一部分概述
1．文档说明
2．系统需求概述
第二部分系统总体结构
第三部分系统设计
类图
//*系统中主要的、关键实体类图，参考图如下*//
➢[用例1]实现
●时序图
//用例1的时序图，参考图如下*// 描述
第四部分数据库设计
1．逻辑设计
数据库关系图：
2．表设计
//*所有的表的详细设计信息汇总，如：*//
4.1 数据库：GameCardSale所有表信息
表名功能说明
UserInfo 存放用户基本信息
UserState 可扩展性，设置用户是否被屏蔽的状态
4.2 表UserInfo
4.3 表UserState
4.4 表RoleInfo
4.5 表SysFun
4.6 表RoleRight
4.8 表DepartInfo
4.9 表
4.10 表
4.11 表AccessoryFile
4.12 表ManualSign
4.13 表WorkTime
4.14 表Message
4.15 表MessageType
4.16 表MessageToUser
4.17 表ReadCommonMessage
4.18 表Schedule
4.19 表MeetingInfo
4.20 表PreContract
4.21 表MyNote
4.22 表LoginLog
LoginTime DateTime 非空登录时间
IfSuccess int
非空登录是否成功。

1：成功、0失败。

LoginUserIp varchar(100) 非空登录用户IP
LoginDesc varchar(100) 登录备注
4.23 表OperateLog
表
名
列名数据类型（精度范围）空/非空约束条件其他说明
OperateId int 非空种子，自增1 操作日志Id
UserId Varchar(50) 非空操作者
OperateName Varchar(50) 非空操作名称
ObjectId Varchar(50) 非空操作对象Id
OperateDesc Varchar(200) 非空操作描述
OperateTime DateTime 非空操作时间
第五部分界面设计
1．公共模块界面设计
说明：页面设计要求尽量使用div布局完成。

所有的GridView要求实现分页功能。

图1.1用户登陆首页
用户登陆首页要求：只有当用户名、密码都正确时才能通过验证。

图1.2 管理员登录后看到的主界面
管理员登录后的主页面要求：显示个人便签信息，左侧显示系统菜单和个人基本信息，上标栏有“主
页”、“重新登录”、“修改密码”、显示当前时间功能。

图1.3 普通用户登录后看到的界面
普通会员登录后的主页面要求：直接到个人签到页面，其他同管理员登录。

签卡日期不能为空，且必须为
日期型。

2．人事管理模块界面实现
//*用例界面实现是对需求的进一步明确和以可视化的方式呈现，作为编码和实现依据*//
➢用例1
人事管理模块包括3个子模块，如图2.1所示。

包括3个子模块
图2.1 人事管理模块包括3个子模块
机构信息管理界面：（如图2.2所示）
图2.2机构信息管理界面
机构信息管理页面功能要求：用GridView显示所有机构信息如图2.2所示，初始时“保存按钮”为不可用。

页面有添加机构功能，使用模板列执行修改和删除机构操作，执行增、删、改后都要重新绑定GridView，显示出机构的最新信息。

填写机构名称、机构简称，添加成功后，机构名称和机构简称输入框都为置空，点修改图标后，在输入框中显示对应的信息，同时“添加”按钮不可用，“保存修改”按钮为可用，保存成功后，“添加”按钮可用，“保存修改”按钮不可用。

注意非空验证。

➢用例2
部门管理界面：（如图2.3所示）
图2.3 部门管理页面
部门页面功能要求：用GridView显示所有机构信息，如图2.3所示，该页面有部门增加、删除、修改功能。

点“添加部门”按钮，或点修改图标都进入保存部门信息页面，如图 2.4所示。

保存部门信息页
图2.4 保存部门信息页面布局
保存部门信息页面功能要求：所属机构下拉菜单绑定机构信息表，注意输入框有效性验证。

如果是修改部门则要显示选定部门的基本信息。

点“请点击选择用户”按钮，则树型显示所有用户，且按机构、
部门分类，如图2.5所示。

图2.5 以树型菜单显示所有用户
选中某用户后，“部门负责人”输入框自动显示该用户姓名，且为只读，树型用户菜单自动隐藏。

如图
2.6所示。

绑定刚才选择的用户
图2.6 选择用户后的界面
如果选择的不是用户，而是机构或部门，则报告选择错误“您选择的不是人员，请重新选择！”。

添加或修改部门成功后，跳转到部门管理页面。

➢用例3
员工管理界面：（如图2.7所示）
图2.7 员工管理界面
员工管理页面功能要求：用GridView展示所有用户基本信息，页面有用户添加、修改、删除和浏览详情功能，执行增、删、改成功后，GridView重新绑定显示用户信息。

点“添加用户”按钮和修改用户图标进入用户信息保存页面，如图2.8 所示。

图2.8 保存用户页面
保存用户信息页面功能要求：用户信息要求非空和有效性验证，“所在部门”下拉菜单项来自数据库DepartInfo表，文本和值分别对应DepartName和DepartId字段（后续机构和部门下拉菜单项都来自对应的表，不再赘述）。

点“浏览”按钮可以选择用户照片，如图2.9所示。

图2.9 选择用户照片
点“保存”按钮添加该用户，然后跳转到员工管理页面，
同时把图片上传到“D:/WebSite/MyOffice/WebUI/images/Users”文件夹中。

注意这里文件名定义为：用户登录名 + “.jpg”格式，如刚才上传的图片添加用户后保存为“qijingxue.jpg”，
图2.10 上传后的图片命名
点“详细”可以查看更详细的信息，如图2.11所示。

图2.11 用户详情页面
用户详情页面功能要求：显示用户基本信息，如图2.11中所列出，在该用户照片上要添加水印效果“我的Office 系统”。

3．日程管理模块界面实现
//*用例界面实现是对需求的进一步明确和以可视化的方式呈现，作为编码和实现依据*//
➢ 用例1
日程管理模块包括3个子模块，如图3.1所示。

个人日程管理页面：实现效果如图3.1所示。

个人日程管理页面功能要求：用calendar 日历控件显示日历，如图3.1所示，使用DayRender 事件绑定显示农历时间和日历小图标，如图3.2所示。

对应数据库Schedule 表。

水印效果
包括3个子模块
日历小图标
图3.2 点日历小图标可以添加日程
点日历小图标可以进入“我的日程安排”页面，比如命名为“SaveMySchedule.aspx”，如图 3.3所
图3.3 我的日程添加页面
我的日程安排页面功能要求：要求填写日程主题、日程地点、会议类型（下拉菜单数据项与MeetingInfo表字段对应）、开始时间、结束时间、提醒内容、预约他人一起参与，同时可以选择是否公开日程，如果公开日程，则部门内其他人在部门日程中可以查看您的日程，如果不公开，其他人看不到您的日程，同时显示创建者和创建时间。

对应Schedule 、MeetingInfo和PreContract表。

点预约他人小图标，则显示所有用户，如图3.4所示，
图3.4 出现预约用户树型菜单
如果选择的不是用户，要提示“您选择的不是人员，请重新选择的提示！”选择用户后，在预约他们列表
图3.5 列表中列出选择的预约人
选择某个预约的人，点“删除选定预约人”按钮，可以从预约他人列表中删除该人，如已经添加了两个预约人，如图3.6所示。

图3.6 选择预约用户“销售部—齐静雪”
删除后的界面如图3.5所示。

点“保存退出”按钮，则跳转到个人日程管理页面，这时显示“◎ + 日程
图3.7 添加日程成功后的界面
这时我们再点日历小图标，或点“◎ + 日程小时和分钟 + 日程标题的前三字 + ...”部分，仍然进入“我的日程安排”页面，即“SaveMySchedule.aspx”，这时将显示该日程的信息，即点“保存退出”按钮时执行修改操作，如图3.8所示。

图3.8 如果日程已经存在，则显示日程信息
添加时可以让“删除”按钮不可用，修改时置为可用。

➢用例2
部门日程页面：如图3.9所示。

图3.9 部门日程页面
部门日程页面功能要求：要求按部门进行日程查询，选择机构后部门下拉菜单级联改变，要求实现选择下拉项后无刷新，如图 3.9所示，可以按部门内用户姓名进行模糊查询，日期只能绑定到某一天，初始时不显示日程信息，点“搜索”图片按钮后，返回查询结果，如图3.10所示。

图3.10 显示查询到所有日程
注意：用GridView显示查询到的日程信息，标题部分包括人员姓名、查询日期所在周的一周各天，要显示一周的各天对应当月的几号，内容部分包括用户姓名，和一周内用户各天对应的日程，任何一个用户可以查看本部门内公开的日程和自己创建的日程。

按姓名模糊查询时，如果没有部门内其他用户的日程，则自己创建的日程也要显示出来。

如图 3.11所示。

图3.11 按姓名模糊查询后的部门日程信息
点日程标题进入我的日程安排页面即“SaveMySchedule.aspx”，这时我们只提供查看功能，除了“退出”按钮外，其他按钮都为不可用状态。

如图3.12所示。

图3.12 查看日程信息的界面
➢用例3
我的便签页面如图3.13 所示。

图3.13 我的便签页面
需要用的数据库表：MyNote表。

我的便签页面功能要求：用DataList展示所有便签信息，如图3.13所示。

当便签标题超过12个字时，则以前12个字加“...”表示。

点页面上“新增便签”超连接或点DataList中的便签标题都可以进入个人便签设置页面。

如果是添加，则界面如图3.14所示
图3.14 个人便签设置页面
个人便签页面功能要求：添加时“删除当前便签”按钮不可用，修改时该按钮可用。

如图3.15所示。

图3.15 执行修改操作时的界面
4．文档管理模块界面实现
//*用例界面实现是对需求的进一步明确和以可视化的方式呈现，作为编码和实现依据*//
➢用例1
文档管理模块包括3个子模块，如图4.1所示。

图4.1 文档管理界面
需要用到的数据库表：、、AccessoryFile。

文档管理页面功能要求：如图 4.1黑框中所示。

该页面“”是个框架，左侧为文件树型菜单页面“”，右面为文件内容页面“”。

树型菜单页面功能要求：展示表中的文件夹信息，按父子菜单分层显示，如数据信息如图 4.2所示。

根据ParentId递归绑定到TreeView中。

其中为文件类型，“1”表示文件夹。

图4.2 表参考数据信息
为了方便操作，初始时可以手动创建文件夹“c ：\\部门文档”。

点左侧的文件树型菜单，若类型是文件夹，则在右侧文件内容部分显示该文件夹下所有的子文件，如图
4.3所示。

文件信息用GridView显示，可以执行查看属性和删除操作（删除时只是放入回收站，要
从回收站中彻底删除）。

地址输入框显示树型菜单中选择的文件路径。

图4.3 显示文件夹中的内容
如果类型是非文件夹，则在右侧文件内容部分直接显示文件信息，如图4.4所示。

图4.4 直接显示文件信息
文件内容页面功能要求：如果文件内容页面的文件为文件夹类型，如图4.5所示，
图4.5 从表中知道，文件“所有项目”为文件夹类型
在点文件名称后进入该文件夹的子文件界面，如图4.6所示。

图4.6 进入“所有项目”的子文件信息界面
直到可以看见显示的文件不是文件夹类型，如继续点“MyOffice”则进入“MyOffice”文件夹下的子
图4.7 看到的“MyOffice说明文档”文件信息不是文件夹类型
这时如果再点文件名称，或点GridView中的属性图标，则进入文件属性信息页面，如图4.8所示，
图4.8 文件属性信息页面
文件属性信息页面功能要求：要求填写文件名称、备注、选择文件类型图标，这时文档位置、创建时间、所有者是不可改变的。

在该页面上要显示文件的附件，如我们的“MyOffice说明文档”文件可能包括多个附件，这些附件是我们通过上传文件到指定位置而得到的，它们在硬盘中的实际情况如图 4.9所示。

图4.9 文件“MyOffice说明文档”在硬盘上的文件参考
用GridView列出所有的附件，如图4.8所示。

点删除图标可以删除该附件。

我们点文件属性页面的“浏览”按钮，可以选择要上传的文件，如图4.10所示。

图4.10 选择要上传的附件
然后点“上传”按钮，执行上传操作，要求把附件添加到数据库AccessoryFile表，参考数据信息如图
4.11所示。

图4.11 附件信息表参考数据信息
同时保存文件到硬盘中指定的路径下，如图4.12所示。

图4.12 添加附件后的硬盘文件信息
如果修改过程中点“退出”按钮，则所有修改取消，已经添加的附件从数据库中删除、硬盘中上传的文件也要清除。

图4.13 添加新文件
则也进入文件属性页面，只是这时文件各项信息都为空，只显示所有者为登录用户，位置部分显示所在文件夹的路径，如图4.14所示。

图4.14 添加文件界面
其他描述同修改文件。

提示，上传附件时可考虑先添加文件以得到文件Id。

如果添加过程中点“退出”
按钮，则所有已经添加的信息要全部还原，已经添加到的文件信息删除、已经添加到附件表的信息删除、已经上传到硬盘中指定路径的文件删除。

图4.15 新增文件夹
图4.16 添加文件夹页面
添加文件夹页面功能要求：位置部分显示要添加文件夹的位置。

添加时注意父子菜单的对应，不仅要添加到表，还要在硬盘中创建文件夹。

各字段信息参考数据库表。

➢用例2
回收站页面如图4.17所示。

图4.17 回收站页面
我们从上边用例1中删除“MyOffice”文件（即更改表中IfDelete字段为1），则可以看到如图
4.17所示的界面。

回收站页面功能要求：用GridView显示所有放入回收站的信息。

点“还原”图标则更改表
中IfDelete字段为0，点“永久删除”图标，则彻底删除该文件，及其对应的附件、包括的子文件、和对应的硬盘文件。

➢用例3
文件搜索页面如图4.18所示。

图4.18 文件搜索页面
图4.19 初始时文件搜索页面点“搜索选项”连接，则显示更详细的搜索条件，如图4.20所示。

图4.20 填写查询条件
附件包含的文字部分可以不于考虑，留以后扩展使用。

图4.21 显示搜索结果页面
点文件名称，能看到该文件的详细信息，如图4.22所示。

点文件名选择保存文件即可下载该文件。

图4.22 可以下载查看文件
5．消息传递模块界面实现
//*用例界面实现是对需求的进一步明确和以可视化的方式呈现，作为编码和实现依据*//
➢用例1
消息管理模块包括2个子模块，如图5.1所示。

包括2个子模块
图5.1 消息管理页面
要到的表：Message、MessageType、MessageToUser、ReadCommonMessage。

消息管理页面功能要求：初始界面如图 5.1所示。

可以根据消息有效时间来进行查询，查询发布时间介于开始时间和结束时间时间之间的消息。

如果不是普通用户可以查看所有人发送的消息，而普通用户只能查看自己发送的消息。

如以管理员身份搜索得到的信息界面如图5.2所示。

图5.2 查询结果
用GridView显示消息信息，要求实现修改和删除功能。

当发布前可以修改，但是发布后不可以修改。

如果消息内容超过7个字，则取6个字加“...”表示。

图5.3 查看消息详细内容
如果发送对象不是所有人，点发送对象部分要显示所有的发送对象。

点“添加新消息”超连接或修改消息图标都进入消息填写页面，如果是添加消息则如图5.4所示。

图5.4 消息填写页面
消息填写页面功能要求：消息类型对应MessageType表字段。

开始有效时间和结束有效时间默认为当前的起止时间，如图 5.4所示。

默认发送对象为特定对象，对象筛选范围默认按姓名，姓名输入框要求
图5.5 姓名输入框有自动完成功能
初始时，机构、部门、员工号都为不可用，当选上按机构后，机构下拉菜单为可用，如图5.6所示。

图5.6 机构下拉菜单变为可用
当选中按部门，机构和部门下拉菜单同时变为可用，且这两个菜单有级联关系，选中按员工号后，员工号输入框变为可用，如不选中，上述各项都变为不可用。

点“确定选择范围”按钮按上面4个条件进行
图5.7 显示查询到的用户
可以选中所有，或者选择部分为他们发送信息。

若选择发送对象为所有人，则筛选范围和发送对象都不显示，如图5.8所示。

图5.8 选择发送对象为所有人的界面所有上述选择操作，都要求实现无刷新效果。

点“保存消息”按钮，添加成功后跳转到消息管理页面。

如图5.9所示。

图5.9 跳转到消息管理页面
图5.10 修改消息界面
修改时发送对象不能更改，只能更改消息的其他基本信息。

发布消息后，消息变为不可修改，如图5.11所示，且记录的有效创建时间以发布时间为准。

图5.11 发布后不可再修改消息
➢用例2
信箱页面：实现效果如图5.12所示。

图5.12 信箱页面
信箱页面功能要求：显示收到的和发送的消息信息，已删除和草稿箱功能不用实现，以备以后扩展之用。

收件箱要求显示总共收到的信息个数和未读的信息个数，已发送要求显示所有发送的信息个数。

点收件箱图片按钮能进入收件箱页面，如图5.13所示，
图5.13 收件箱页面
收件箱页面功能要求：用GridView显示所有收到的信息，有鼠标光亮效果，可以删除选定的消息，在GridView每一行上添加鼠标点击事件，弹出模式窗口，显示消息详细内容，弹出“ReceiveMailDetail.aspx”页面，如图5.14所示。

图5.14 弹出模式窗口显示消息详细内容
关闭模式窗口后，回到收件箱页面，如图5.15所示。

图5.15 新消息阅读后的界面
这时消息未读标志已经消失。

同时左侧菜单上面的用户信息部分，要求使用 AJAX实现无刷新提示功能，如果有人给登录者发送新消息，则立刻显示新消息图标，并显示共有几条新消息。

如果没有新消息，则新消息图标消失。

如果从信箱页面点“已发送”图片按钮，则进入已发送信息页面，如图5.16所示。

图5.16 已发送信息页面
已发送信息页面功能要求：只显示登录用户自己发送的信息，可以删除已经发送的信息，添加鼠标光亮效果，鼠标点击某一行信息，可以查看消息详细信息，弹出“ReceiveMailDetail.aspx”页面，如图5.17所示。

图5.17 查看已发送信息详情。