SOKLIB知识库管理系统需求文档

1、SOKLIB知识库管理系统需求规格说明书编写人员：俞育峰、周长青、刘宸哲编写时间：2016年04月18日 目录1.概述31.1.编写目的31.2.术语和标记32.项目概述32.1.项目总体目标32.2.系统开发背景42.3.主要限制和开发风险分析53.功能需求53.1.功能模型83.1.1.知识导入模块83.1.2.知识归纳模块103.1.3.知识收藏模块123.1.4.个人知识管理模块153.1.5.个人信息管理模块163.1.6.公共知识网络结构模块183.1.7.公共知识检索模块193.1.8.文档推荐模块213.1.9.消息管理模块223.1.10.后台信息统计模块233.1.11.后

2、台用户管理模块253.1.12.后台知识文件管理模块273.1.13.后台分类管理模块293.1.14.后台系统日志模块313.2.性能需求323.3.非功能需求323.4.故障处理324.数据需求324.1.数据项324.2.实体关系355.行为需求355.1.控制模型356.接口需求366.1.用户界面367.环境397.1.运行环境397.2.开发环境391. 概述1.1. 编写目的本文档的编写目的是为SOKLIB知识库管理系统项目的开发提供：a) 软件总体要求，作为用户和软件开发人员之间了解的基础；b) 功能、性能、接口和可靠性的要求，作为软件人员进行设计和编码的基础；c) 验收标准，

3、作为用户确认测试的依据1.2. 术语和标记Spring MVC： SpringFrameWork的后续产品Spring 框架提供了构建 Web 应用程序的全功能 MVC 模块；MyBatis：一个基于Java的持久层框架；Apache：专门为运作一个开源软件项目的Apache 的团体提供支持的非盈利性组织；Lucene: 一个开放源代码的全文检索引擎工具包；Git：一款免费、开源的分布式版本控制系统；OpenOffice：是一套跨平台的办公室软件套件，能在Windows、Linux、MacOS X (X11)和 Solaris 等操作系统上执行。2. 项目概述2.1. 项目总体目标a) 组织、

4、公司内部人员知识资源共享b) 方便有效管理个人知识资源c) 各种知识载体的在线显示d) 系统智能的帮助用户归纳、整理学习到的资源e) 支持文件的批量上传及压缩包导入，支持Office文档、PDF、图像、音视频和图纸等各类型文件。f) 支持文档的批量关联。支持通过文件唯一编号，实现文档与相关文档、图纸、图片及其它格式附件进行关联，点击链接即可一键快速查看。系统支持为图片、音、视频类文件增加摘要及缩略图。g) 快速从海量资料中检索所需文件；2.2. 系统开发背景我们工作学习生活中处处都充满着各种知识。比如说我们在电脑上看电影，我们需要知道如何观看电影的在电脑操作知识，我们开车去游玩，我们需要驾驶汽

5、车的技能知识。我们在不断的累计我们获得的知识，它们是我们的财富。然而，在某些时候，我们在我们的大脑中无法记住更多的知识，这时候，知识就会以各种载体的知识存在着。比如，书本、视频、图片、电子文档等。它们都是我们不可缺的财富。然而，当知识越来越多，我们就需要方便的去管理他们，并且能让我们在知识的海洋中准确的找到它们，我们就需要一个管理系统去管理它们。生活中、工作中、学习中都不可或缺。在这套系统中，我们需要一个个人知识库去整理归纳自己学习到的知识，一个共享知识库去互相分享学习。在使用的过程中，我想，所有用户都希望只借助一个浏览器就可以完成所有的过程，包括学习和分享，也希望在当今时代能跟上产品智能的潮

6、流，我们需要一套智能化的知识库管理系统来助推个人及组织目标的实现。图 2.1 组织、企业知识库系统模式2.3. 主要限制和开发风险分析a) 文件格式限制：由于文件格式种类很多、很多特殊的格式不能在进行处理以进行转化来在线显示。b) 智能提取的准确性：本系统尽量使文档的智能抽取准确度提高。3. 功能需求表 3.1 功能模块业务模块功能划分简要描述知识导入模块直接导入知识文件各种类型文件的导入、转换使其可以在线浏览压缩文件解压导入导入压缩包内的文件，并对压缩包内文件依次处理知识归纳模块新建文档新建一个知识笔记智能提取提取系统中文档知识点，并插入到笔记中文档编辑对归纳的知识进行编辑保存保持文档到库中

7、知识收藏模块知识收藏对已经收藏的知识，和文件夹文档进行管理、查看个人知识管理模块管理知识用户对自己的文档、资源管理修改资源修改文档的基本信息，包括名称、分类、关联、权限、缩略图查看文档在线浏览文档个人信息管理模块个人信息对个人信息的查看、修改基本信息、修改密码、修改头像等公共知识网络结构模块分类查看知识文档按树结构显示每个分类下（包括子分类）的全部文档知识图谱显示该分类下的知识结构体系公共知识检索模块检索知识按条件检索知识，包括关键信息、关键词、文件类型、文件分类、日期等筛选知识对已经检索到的知识进行筛选，并再次对结果查询文档推荐模块推荐文档推荐给用户可能感兴趣的文档消息管理模块消息管理管理系

8、统发给用户的消息发件箱给用户发送系统消息后台信息统计模块信息统计以图表的方式统计网站的一些基本信息后台用户管理模块用户管理管理用户账号，包括冻结账号、初始化密码、分配角色等后台知识文件管理模块文件管理管理所有用户的文档、审核不符合要求的文档后台分类管理模块分类管理管理文档分类后台系统日志模块系统日志查看时时日志和近期日志3.1. 功能模型3.1.1. 知识导入模块图3.1知识导入模块l 导入资源用例简要描述：导入用户选择的资源到个人知识库中事件流：1. 选择要导入的文件2. 上传文件，并保存基本信息到数据库和保存文件到服务器磁盘中。l 解压压缩文件用例简要描述：解压用户要上传的压缩文件事件流：

9、1. 用户选择压缩文件，并选择压缩上传2. 解压用户选择的压缩文件l 文件处理审核简要描述：审核并处理用户上传的文件事件流：1. 判断用户上传的文件类型2. 如果用户上传的文件类型支持系统中在线预览类型，则直接保存。3. 如果用户上传的文件不支持系统在线预览，则转换成相应的格式。4. 提取文件中的缩略图、摘要、文本信息。5. 处理完之后交给管理员或系统自动审核l 修改导入资源基本信息简要描述：用户修改刚刚上传的资源基本信息事件流：1. 选择上传完成后列表中的文件2. 点击修改3. 对系统提取的摘要等信息不满意进行修改，包括缩略图、名称、分类、关联文档、简介、共享还是私有等4. 保持修改3.1.

10、2. 知识归纳模块图3.2知识归纳模块l 新建文档简要描述：新建文档事件流：1. 新建一个文档l 编辑文档简要描述：编辑文档内容事件流：1. 在编辑器中编辑文档中的内容l 智能提取简要描述：智能提取事件流：1. 用户选择智能提取2. 用户输入知识点3. 系统自动提取4. 用户选择并排序抽取内容5. 用户点击插入到编辑文档中l 保存文档简要描述：保存文档事件流：1. 用户点击保存归纳的文档2. 系统自动处理文档文件3. 系统处理完毕后用户填写基本的文档信息4. 用户选择保存3.1.3. 知识收藏模块图3.3知识收藏模块l 收藏知识简要描述：收藏知识资源事件流：1. 收藏查看的知识文档2. 选择收

11、到到的文件夹爱3. 保存l 查看收藏夹简要描述：查看收藏夹事件流：1. 选择收藏夹2. 查看该收藏夹下收藏的文档l 编辑收藏信息简要描述：编辑收藏的文档的收藏信息事件流：1. 查看收藏夹下的文件2. 选择修改信息3. 填写收藏的备注4. 保存收藏信息l 删除收藏的知识简要描述：删除收藏内容事件流：1. 查看收藏夹下的文件2. 选择删除3. 删除收藏文件l 添加收藏夹简要描述：编辑收藏的文档的收藏信息事件流：1. 查看我的收藏2. 点击新建收藏夹3. 填写基本信息4. 完成新建收藏夹l 删除收藏夹简要描述：删除收藏内容事件流：1. 查看我的收藏2. 选择删除收藏夹3. 选择要删除的收藏夹4. 选

12、择删除5. 删除收藏夹并删除该收藏夹下所有的收藏3.1.4. 个人知识管理模块图3.4个人知识库管理模块l 删除文档简要描述：删除资源文档事件流：1. 选择删除文档2. 删除文档信息，更新数据库3. 删除文档文件4. 删除文档索引l 修改文档简要描述：修改一个资源文档的基本信息事件流：1. 用户选择一个文档2. 点击修改3. 填写基本信息，包括文件名称、分类、关联（可自动关联）、缩略图等4. 用户点击保存修改，更新数据库5. 如果文档为公开，则系统进行索引的创建6. 如果文档问私有，则系统删除其索引l 查看文档简要描述：查看资源文档事件流：1. 用户选择要查看的文档，点击在线预览2. 系统判断

13、用户要查看的文件类型3. 系统自动匹配适合文件类型的查看器4. 用户在网页中浏览3.1.5. 个人信息管理模块图3.5个人信息管理模块l 修改用户昵称密码等基本信息简要描述：修改用户基本信息和密码修改事件流：1. 用户查看自己的信息2. 点击修改3. 用户填写基本的信息4. 如果修改密码，则要求验证原来的密码5. 保存修改l 修改绑定邮箱简要描述：修改用户基本信息事件流：1. 系统验证用户密码2. 用户修改绑定邮箱3. 系统发送邮件到用户邮箱中4. 用户点击自己邮件中的链接，完成邮箱绑定更换l 修改头像简要描述：修改用户头像事件流：1. 用户点击头像2. 系统弹出选择框3. 用户选择要更换的头

14、像，并点击上传4. 系统保存用户新头像到磁盘3.1.6. 公共知识网络结构模块图3.6 公共知识网络结构模块l 查看分类下知识文档简要描述：查看当前分类下所有的公共文档信息事件流：1. 用户选择公共知识的知识网络页面2. 用户选择一个分类3. 系统分页按录入时间降序列出该分类下所有的文档l 查看当前类下的知识结构简要描述：查看当前分类下所有的公共文档信息事件流：1. 用户选择一个知识点2. 点击查看知识结构按钮3. 系统递归列出类结构3.1.7. 公共知识检索模块图3.7公共知识检索模块l 全文检索公共知识库简要描述：输入关键信息检索公共知识库事件流：1. 用户输入关键信息2. 用户点击搜索按

15、钮3. 系统根据用的的信息检索列出文档列表l 按条件检索知识库简要描述：按条件（名称、知识点、知识分类、文件类型、时间范围）检索公共知识库事件流：1. 用户输入条件2. 系统根据用的的信息检索列出文档列表l 检索结果集简要描述：对于用户全文检索或条件查找到的结果进行再次查询，提高精确度事件流：1. 用户输入信息进行全文检索或条件查找2. 在写列出文档列表后，用户再次输入条件信息3. 用户点击结果查询按钮4. 系统给出结果3.1.8. 文档推荐模块图3.8 文档推荐模块l 热门文档简要描述：把近期的热门文档推荐给用户事件流：1. 系统统计最近热门的文档2. 用户选择热门文档页面3. 系统呈现文档

16、列表l 最新上传简要描述：把近期的上传文档推荐给用户事件流：1.系统给出最新上传的公共文档l 个性推荐简要描述：系统根据用户的浏览习惯，进行数据挖掘，并智能推荐用户可能感兴趣的文档事件流：1. 用户浏览产生浏览记录2. 系统调用当前用户和其他用户产生的浏览记录，进行一定的挖掘关联，统计出用户可能会感兴趣的文档3. 系统推送到用户主页3.1.9. 消息管理模块图3.9消息管理模块l 消息推送简要描述：系统或管理员推送消息给用户事件流：1. 用户产生一定的行为2. 系统对用户的行为进行一定判断3. 如果该消息对用户比较重要（如文件审核成功）就推送给用户4. 管理员发送消息给用户3.1.10. 后台

17、信息统计模块图3.10后台信息统计模块l 近期上传量统计简要描述：统计最近7天系统库中的文档增加情况事件流：1. 用户上传资源2. 管理员查看统计信息3. 系统统计出最近7天系统库中的文档增加情况l 近期文档点击统计简要描述：文档点击量排行事件流：1. 用户查看文档时留下浏览记录2. 管理员查看统计信息3. 系统统计出点击量高的资源显示给管理员l 热门分类统计简要描述：热门分类排行事件流：1. 管理员查看各个分类具体情况2. 系统统计处每个分类的文档持有量、被访问量l 活跃用户统计简要描述：活跃用户排行事件流：1. 管理员查看统计表2. 系统根据用户的动态情况统计出活跃的用户3.1.11. 后

18、台用户管理模块图3.11 后台用户管理模块l 冻结用户帐号简要描述：冻结用户帐号事件流：管理员冻结用户帐号l 删除帐号简要描述：删除用户帐号事件流：管理员删除用户帐号l 初始化密码简要描述：初始化用户密码事件流：管理员初始化用户密码，更新数据库l 设置权限简要描述：设置用户帐号权限事件流：管理员设置用户帐号权限，更新数据库3.1.12. 后台知识文件管理模块图3.12后台知识文件管理模块l 删除资源简要描述：删除资源事件流：管理员删除资源，更新数据库l 审核资源简要描述：审核用户上传的资源事件流：1. 用户上传资源2. 管理员审核资源，更新数据库l 冻结资源简要描述：冻结资源事件流：1. 管理

19、员选择资源2. 管理员冻结资源，更新数据库l 取消冻结资源简要描述：取消冻结资源事件流：1. 管理员选择资源2. 管理员取消冻结资源，更新数据库3.1.13. 后台分类管理模块图3.13后台分类管理模块l 查看分类简要描述：查看分类信息事件流：1. 管理员选择一个分类2. 查看那分类信息l 修改分类简要描述：修改分类信息事件流：1. 管理员选择一个分类2. 修改分类的信息，包括名称、简介、缩略图3. 保存修改，更新数据库l 增加分类简要描述：增加分类信息事件流：1. 管理员选择一个分类节点2. 在该分类节点下增加节点3. 填写分类的基本信息4. 保存信息并，更新数据库l 删除分类简要描述：删除

20、分类信息事件流：1. 管理员选择分类2. 选择删除分类，并更新数据库3.1.14. 后台系统日志模块图3.14后台系统之日模块l 查看时时日志简要描述：查看系统中的时时日志事件流：1. 系统中不断产生日志记录并记录到文件中2. 管理员在后台中查看l 查看近期日志简要描述：查看系统中近期日志事件流：1. 系统记录近期的日志到文件中2. 管理员选择要查看的日期3. 系统呈现日志到界面3.2. 性能需求资料存储：管理的资料素材数目：1百万；资料综合分析：通联关系分析时间：10万条记录下，3分钟；文本处理：全文检索，当用户输入的查询词小于10个时，检索的响应速度小于5秒3.3. 非功能需求文本处理：命

21、名实体识别功能，能够支持中文，人名、组织机构名、时间、地名、目标类型、目标名称等； 文本处理：文本抽取功能，能够对pdf, office 2003/2007, html, email，chm，zip，rar抽取文本内容。3.4. 故障处理系统采用高可用性冗余服务器，当主服务器出现访问故障时，可自动启用备用服务器。4. 数据需求4.1. 数据项a) 分类表classificationTABLE_NAMECOLUMN_TYPECOLUMN_COMMENTclassificationbigint(20)类别idclassificationvarchar(100)类别名称classificationt

22、ext类别简介classificationvarchar(255)类别表示图片classificationbigint(20)父节点classificationvarchar(200)父节点路径b) 点击记录表click_infoclick_infobigint(20)点击数据编号click_infobigint(20)用户idclick_infobigint(20)文档idclick_infotimestamp点击时间c) 文件夹表doc_infodoc_infobigint(20)文件夹iddoc_infobigint(20)用户iddoc_infovarchar(100)文件夹名称doc

23、_infovarchar(255)文件夹简介doc_infotimestamp文件夹创建时间d) 文件信息表file_infofile_infobigint(20)文件idfile_infovarchar(255)文件名file_infobigint(20)文件大小file_infovarchar(10)文件后缀(类型)file_infotext文件简介file_infobigint(20)上传用户idfile_infovarchar(255)文件唯一编码uuidfile_infovarchar(255)文件路径file_infoint(5)文件状态：0未上传，1处理失败，2已经上传，3处理文

24、件中，4审核中，5上传成功所有人可以查看，6上传成功私有，7文件被冻结锁定file_infobigint(20)文件种类idfile_infotimestamp文件上传时间e) 收藏信息表fork_infofork_infobigint(20)收藏编号fork_infobigint(20)收藏到的文件夹编号fork_infobigint(20)收藏的文件编号fork_infotimestamp收藏时间fork_infovarchar(255)备注f) 消息表message_infomessage_infobigint(20)消息idmessage_infovarchar(255)消息内容message_infobit(1)消息读取情况message_infobigint(20)发送给用户idmessage_infotimestamp发送时间g) 用户表user_infouser_infobigint(20)用户iduser_infovarchar(100)用户名user_infovarchar(60)用户密码，默认user_infoi