Tips系统需求
来源:广州软件开发 编辑:广州软件开发公司 日期:2017-03-23
1. 需求定义
1.1. 概要
本系统主要提供给Honeywell S&PS China部门SA提交和管理Solution Tips(以下简称ST)及Technical Profile(以下简称TP)等文档使用。
SA遵照系统中文档的提交数量和时间要求,按时按量按质提交文档。
SA Leader在系统中对文档进行评分,系统根据评分计算规则生成文档排名。
管理员通过系统进行文档管理,对需要脱敏(去除敏感信息)的文档进行脱敏编辑上传。可以根据SA内部分享/其他部门分享/代理商分享/组织WebEx会议/月刊制作/奖项评比等不同需求用途导出相应的文档列表和内容。
支持代理商工程师注册账号,参与ST编写提交的功能。(本功能根据系统是否开放到公网待定)
1.2. 部门及用户
现使用部门为SA Team,包括且不限于以下子部门(以下也称“区域”):EC SA Term(东区),NC SA Team(北区),SC SA Team(南区),OEM SA Team(OEM),HKTW SA Team(香港台湾地区)。
现使用用户为SA Team的成员。未来Sales Team等部门可以通过注册该系统账号查阅部分文档。
1.3. 角色定义
现阶段使用角色定义如下:
角色 |
职责 |
管理员 |
Ø 设置系统参数。
Ø 脱敏文档。
Ø 按需导出文档及提交状况报表。
Ø 新用户注册审核。 |
SA Leader |
Ø 按照ST和TP提交时间和数量要求,在系统中进行文档编写和提交。
Ø 获取所有文档。
Ø 每月在规定时间内,对SA提交的文档进行评分。 |
一般SA |
Ø 按照ST和TP提交时间和数量要求,在系统中进行文档编写和提交。
Ø 获取不需要脱敏的和已完成脱敏的文档。 |
代理商工程师(待定) |
Ø 在系统中进行ST文档编写和提交。 |
1.4. 文档提交规则
当前规定为如下,考虑支持规则调整。
SA Leader:每季度提交1篇ST,每半年提交1篇TP。
一般SA:每月提交1篇ST,每季度提交1篇TP。
提交的最晚时间点为文档月份的下月8日24:00前。对于季度/半年提交的文档,参照当季度/半年的最末一个月计算。
例如:一般SA,3月份的ST和1季度TP,需要在4月8日24:00前完成编写提交。
超过当月提交时限的文档允许补交,补交的文档在系统中进行标识。补交的文档当月不进行评分,推迟到下一个月进行。
代理商工程师角色没有时间规则限制。
1.5. 文档模板
以下为ST和TP的文档模板定义。管理员上传最新模板,SA每次编写文档前下载最新版本模板进行文档编写提交。
支持版本管理。
未来考虑可以定义其他的文档模板类型。
1.6. 文档编号
ST编号格式为:SST #XXYY-MMNN
TP编号格式为:STP #XXYY-MMNN
其中,XX替换为Team代码:东区——EC,北区——NC,南区——SC,OEM——OEM,香港台湾——HT。YY为年份后两位,MM为月份,NN为该Team的流水编码。
例如:ST文档2017年1月份南区Team提交的第二份文档,编号为SST #SC17-0102。
文档编号为系统根据规则自动生成。
1.7. 文档评分
每篇提交的文档都需要进行评分。
所有SA Leader参与评分。
评分由各个SA Leader独立进行,各个评分结果权重相同。
评分项目包括:
评分项目 |
评分依据 |
分值比重 |
内容呈现 |
Ø 文档格式符合模板规范
Ø 文字表达流畅可读,图片表达清晰到位
Ø 逻辑条理清楚 |
0.2 |
专业性 |
Ø 与S&PS产品及解决方案相关
Ø 可能涉及较高水平的技术
Ø 突出S&PS产品及解决方案的优势
Ø 使用具有说服力的实际用例和数据 |
0.3 |
创新性 |
Ø 以往资料未涉及或较少涉及的内容
Ø 对某类问题提出新的解决方法(更有效果/效率更高/成本更低/……)
Ø 对某些已有问题解决方法提出新的更有效的描述
Ø 提供新的行业/技术平台/竞争对手情况等内容 |
0.3 |
实用性 |
Ø 日常工作中普遍容易碰到
Ø 解决问题的方法可操作性强
Ø 文档对于供应商或客户容易理解 |
0.2 |
是否推荐 |
单选:“是”/“否”。默认为“否”。 |
是否脱敏 |
单选:“是”/“否”。ST默认为“否”;TP默认为“是”。 |
评分备注 |
可选填写 |
每篇文档每项评分点按照1~10分数进行评分(1为最低分,10为最高分),各项得分乘以分值比重后求和即为总分。平均各个参与评分的SA Leader的总分,该平均分即为文档最终评比得分。
对“是否推荐”和“是否脱敏”进行记数。
以上评分项目和分值比重设置允许调整。
文档评分在每月20日24:00前完成。该时间支持调整。
评分明细表和汇总表可以参照以下格式:
1.8. 文档推荐
评分中的“是否推荐”会影响文档是否入选月刊。
需要推荐数大于等于参与评分的SA Leader人数才可以入选月刊。
将该规则在评分页面进行提醒。
1.9. 文档脱敏
只要有任意一个评分中的“是否脱敏”选择了“是”,该文档内容就需要脱敏才可以在管理员和SA Leader之外共享。
将该规则在评分页面进行提醒。
每个文档(或只针对需要脱敏的文档)允许添加一个脱敏内容的版本。由管理员进行脱敏编辑后保存在脱敏版本,原提交文档内容不变。
1.10. 文档导出
所有文档包括脱敏版本支持单个或批量导出为Word格式和PDF格式。
1.11. 报表查询
系统允许进行以下报表查询:
Ø 提交文档列表查询和导出(按文档类型/时间/区域/文档编号/主题/作者)
Ø 文档评分明细查询和导出(按文档类型/时间/区域/文档编号/作者/评分人员/是否推荐/是否脱敏)
Ø 文档评分汇总查询和导出(按文档类型/时间/区域/文档编号/作者/是否推荐/是否脱敏)
Ø 文档提交情况查询(按时间/区域)
1.12. 用户注册
新用户(SA和代理商工程师等)使用工作邮箱地址进行注册,管理员审核并为其分配角色权限后,账号生效。
1.13. 邮件服务
对以下内容提供邮件服务:
Ø 新用户注册电子邮箱地址验证
Ø 密码找回验证
Ø 新用户注册审核通过/失败提醒
Ø 每月文档提交提醒(默认未完成提交的情况下提前3天通知)
Ø 每月评分提醒(发送给SA Leader,默认未完成评分的情况下提前3天通知)
2. 架构概要
系统使用B/S架构,在服务端部署数据库服务、应用服务和文件存储服务;用户通过Web浏览器(系统需支持兼容IE、Google Chrome等浏览器的主流版本)进行访问和使用。
3. 功能界面描述
3.1. 系统登陆
3.1.1. 功能说明
Ø 用户输入账号(电子邮箱地址)和密码登陆到系统。
Ø 新用户注册。
Ø 支持密码修改。
Ø 支持忘记密码邮件重置。
3.1.2. 使用角色
Ø 全体用户
3.1.3. UI设计
3.2. 部门管理
3.2.1. 功能说明
Ø 维护部门资料,支持层级定义。
3.2.2. 使用角色
Ø 管理员
3.2.3. 表单字段
3.2.4. UI设计
3.3. 用户管理
3.3.1. 功能说明
Ø 维护用户资料。可以编辑用户姓名和所属部门。可以重置用户密码。
3.3.2. 使用角色
Ø 管理员
3.3.3. 表单字段
3.3.4. UI设计
3.4. 角色分配
3.4.1. 功能说明
Ø 维护系统角色。
Ø 设置角色下的用户。
Ø 设置角色的界面功能权限,对系统每个功能模块的增删改查操作权限进行分配。对于文档导出,控制可以导出的文档类型。
3.4.2. 使用角色
Ø 管理员
3.4.3. UI设计
3.5. 提交规则
3.5.1. 功能说明
Ø 对ST和TP分别设置规则。
Ø 对各个角色(当前为SA Leader和SA)分别设置规则。
Ø 在规则上选择以“月”/“季度”/“半年”为单位。
Ø 设置每月最迟提交日。
Ø 设置例外账号。
3.5.2. 使用角色
Ø 管理员
3.5.3. UI设计
3.6. 模板上传
3.6.1. 功能说明
Ø 分ST/TP/……不同文档模板进行管理。支持版本控制。
Ø 模板有更新的情况下,管理员上传最新模板。
3.6.2. 使用角色
Ø 管理员
3.6.3. UI设计
3.7. 评分项目
3.7.1. 功能说明
Ø 维护评分项目。允许添加、修改和移除评分项目和分值比重。
Ø “是否推荐”和“是否必填”为固定项目。
3.7.2. 使用角色
Ø 管理员
3.7.3. 表单字段
3.7.4. UI设计
3.8. 文档提交
3.8.1. 功能说明
Ø SA新建一个文档项目,下载文档项目最新模板(Word),按照模板进行内容编写后提交。并可以提交一个或多个附件。
Ø 系统记录提交时间。
Ø 可以考虑把提交信息(如文档编号/作者/提交时间)写入提交的Word文档中。
Ø 文档在提交后允许进行再次更新提交,系统记录更新时间,保存提交历史版本。
Ø SA可以按时间/文档类型(ST/TP)筛选查看已提交的文档并进行更新。
3.8.2. 使用角色
Ø SA Leader
Ø 一般SA
Ø 代理商工程师(待定)
3.8.3. UI设计
3.9. 文档评分
3.9.1. 功能说明
Ø 每月在设定的文档提交时间点后,开放当月文档的评分通道。
Ø SA Leader访问该界面,系统显示当月文档列表。
Ø SA Leader点击列表里的文档链接,查看文档内容。随后按照评分项目逐一进行评分,中途可以保存退出。全部文档评分完成后进行提交,如有文档评分未完成,不允许提交。
Ø 文档评分完成要求时间点仅作为提醒用,如果超过该时间点,仍然允许评分。
3.9.2. 使用角色
Ø SA Leader
3.9.3. 表单字段
文档编号(只读) |
主题(只读) |
作者(来源于用户姓名)(只读) |
提交时间(只读) |
< 评分项目明细…> |
是否推荐 |
是否脱敏 |
评分备注 |
3.9.4. UI设计
3.10. 文档脱敏
3.10.1. 功能说明
Ø 查询未脱敏文档列表(按时间/文档类型/区域/文档编号)
Ø 开始脱敏操作,系统将原内容复制到脱敏版本上,管理员编辑内容移除敏感信息,保存为脱敏版本。
3.10.2. 使用角色
Ø 管理员
3.10.3. UI设计
3.11. 文档查询和导出
3.11.1. 功能说明
Ø 查询条件:文档类型(ST/TP)/开始月份/结束月份/区域/文档编号(模糊匹配)/主题(模糊匹配)/作者(用户姓名)/是否全文检索(根据实现的可行性待定)
Ø 查询结果列:区域/文档编号/主题/作者/提交时间
Ø 可以勾选文档批量导出为Word和PDF格式文档。
3.11.2. 使用角色
Ø 管理员:可以查询和导出全部,包括脱敏/未脱敏版本
Ø SA Leader:可以查询和导出全部,包括脱敏/未脱敏版本
Ø 其他:可以查询和导出不需要脱敏的和已脱敏的ST(未来可增加已脱敏版本TP的导出)
3.11.3. UI设计
3.12. 文档评分明细查询
3.12.1. 功能说明
Ø 查询条件:文档类型(ST/TP)/开始月份/结束月份/区域/文档编号(模糊匹配)/作者(用户姓名)/评分人员(用户姓名)/是否推荐/是否脱敏
Ø 查询结果列:区域/文档编号/主题/作者/提交时间/评分人员/< 评分项目明细…>/总分/是否推荐/是否脱敏/评分备注
3.12.2. 使用角色
Ø 管理员
Ø SA Leader
3.12.3. UI设计
3.13. 文档评分汇总查询
3.13.1. 功能说明
Ø 查询条件:文档类型(ST/TP)/开始月份/结束月份/区域/文档编号(模糊匹配)/作者(用户姓名) /是否推荐/是否脱敏
Ø 查询结果列:区域/文档编号/主题/作者/提交时间/<各评分人员评分…>/平均分/是否推荐/是否脱敏/评分备注
3.13.2. 使用角色
Ø 管理员
Ø SA Leader
3.13.3. UI设计
3.14. 文档提交情况查询
3.14.1. 功能说明
Ø 查询条件:开始月份/结束月份/区域
Ø 查询结果列:区域/作者/ST提交次数/ST按时提交次数/ST平均分/ TP提交次数/TP按时提交次数/TP平均分
3.14.2. 使用角色
Ø 管理员
Ø SA Leader
3.14.3. UI设计
3.15. 系统日志查看
3.15.1. 功能说明
Ø 系统记录用户登陆和关键业务操作日志。
Ø 查询条件:开始时间/结束时间/功能模块/操作用户/操作内容(模糊匹配)
Ø 查询结果列:功能模块/操作用户/操作内容/操作时间
3.15.2. 使用角色
Ø 管理员
4. 功能开发优先级
4.1. 高优先级
Ø 系统登陆
Ø 部门管理
Ø 用户管理
Ø 角色分配
Ø 模板上传
Ø 当前施行的提交规则(不考虑允许配置)
Ø 当前施行的评分项目(不考虑允许配置)
Ø 文档提交
Ø 文档评分
Ø 文档查询和导出
Ø 文档评分明细查询
Ø 文档评分汇总查询
Ø 文档提交情况查询
4.2. 低优先级
Ø 文档脱敏
Ø 文档模板类型的添加(支持ST和TP以外的新模板类型定义、提交和管理)
Ø 系统日志查看
Ø 提交规则的配置
Ø 评分项目的配置
Ø 其他部门查询/导出,代理商工程师使用
相关阅读