[知识路书]功能规格说明书
这是一篇软工课程博客
| 项目 | 内容 |
|---|---|
| 课程：北航-2020-春-软件工程 | 博客园班级博客 |
| 作业要求 | 功能规格说明书 |
| 我们在这个课程的目标是 | 提升团队管理及合作能力，实践软件工程开发 |
| 这个作业在哪个具体方面帮助我们实现目标 | 介绍团队项目【知识路书】，定义项目功能规格 |
关于本组：【敏杰开发团队介绍】
关于选题：【知识路书项目介绍】
术语定义
| 术语 | 参考英文 | 阐释 |
|---|---|---|
| 文献 | - | 学术文献（及对其的抽象），以论文为主要形式，含有标题、作者、发表时间、来源、摘要等属性 |
| 笔记/文献笔记 | note | 用户对一篇文件作出的可编辑笔记与备注，是一段（特定格式的）文本，对于每个用户，一篇文献只能编辑一份笔记 |
| 随笔 | - | 用户编辑的自由体裁的随笔，可以引用任意数量的文献 |
| 路书/知识路书 | roadmap | 一种基于有向图的内容呈现形式，基本组成元素是素材和连接 |
| 素材/路书素材 | - | 文献与随笔与路书都是素材，素材是路书中表示内容实体的元素，以各种结点的形式展现在路书中 |
| 连接/路书连接 | connection | 两个素材间的关系泛称连接 |
用户和典型场景
（以下用户可能虚构，钧采用化名）
用户A
| 用户信息 | 用户情况 |
|---|---|
| 姓名 | 罗之光 |
| 用户身份 | 大二学生，刚加入某计算机视觉实验室 |
| 知识层次/能力 | 有一点点CV基础知识，对于实验室目前的研究方向不了解，需要通过阅读文献来了解相关领域进展。 |
| 用户动机 | 希望了解相关领域的研究历史及最新进展，尽快融入实验室的研究工作中 |
| 用户困难和需求 | 1. 不知道应该阅读哪些经典文献；2. 不知道应该以何种顺序阅读文献；3. 对于该领域的进展，不知道哪些比较值得阅读；4. 每篇文章需要自己从头阅读，直接啃一些硬核的文章比较艰难；5. 没有合适的工具记录阅读文献的心得；6.需要有软件规划论文阅读计划 |
| 典型场景 | 研究新人熟悉研究领域，快速上手 |
| 用户偏好 | 领域知识了解较少；热情高，能投入时间 |
| 用户比例 | 20%左右 |
用户B
| 用户信息 | 用户情况 |
|---|---|
| 姓名 | 罗筠宇 |
| 用户身份 | 研二学生，从事计算机视觉相关研究(普通研究者) |
| 知识层次/能力 | 有研究基础，阅读过很多领域相关文章。 |
| 用户动机 | 希望记录下来自己在阅读文献过程中的笔记、心得；便于自己对于研究思路的梳理、寻找idea |
| 用户困难和需求 | 1.没有合适的工具做文献笔记; 2.不容易整理不同文章之间脉络发展；3.需要有软件规划论文阅读计划；4.需要和组内同学交流对某篇文章的看法 |
| 典型场景 | 研究者在阅读文献过程中无法轻松管理文献 |
| 用户偏好 | 有科研压力，文献阅读量大，希望能快速、清晰管理文献 |
| 用户比例 | 50%左右 |
用户C
| 用户信息 | 用户情况 |
|---|---|
| 姓名 | 罗均宇 |
| 用户身份 | 博五学生 |
| 知识层次/能力 | 研究经历丰富，阅读过丰富文献 |
| 用户动机 | 将要毕业，需要将研究工作交给学弟(妹) |
| 用户困难和需求 | 1.没有直观可视化手段展示研究发展脉络；2.丰富的领域知识无法简单传递下去 |
| 典型场景 | 在某领域较长时间的研究者无法轻易传递文献相关知识 |
| 用户偏好 | 压力大，文献多，需要专门的软件进行管理 |
| 用户比例 | 20%左右 |
用户D
| 用户信息 | 用户情况 |
|---|---|
| 姓名 | 罗钓宇 |
| 用户身份 | 计算机学院教授 |
| 知识层次/能力 | 研究经历丰富，知识水平高 |
| 用户动机 | 希望直观了解某个领域的研究进展，一边和学生确定研究方向；希望看到学生分享近期阅读的文章；希望和同行就某些论文、研究进行学术交流 |
| 用户困难和需求 | 1. 没有直观的论文管理工具展示某领域的研究进展；2. 无法与学生就某篇或某些篇文章进行分享交流 |
| 典型场景 | 研究者希望掌握研究领域进展、希望有更好的论文交流手段 |
| 用户偏好 | 时间紧张，文献多，需要较好的可视化分享手段 |
| 用户比例 | 20%左右 |
界面原型设计
这里可以参考mindmeister的布局
对于文献管理，我们使用一个简单的table view即可，可以参考这个示例
主流交互步骤
导入文献
- 点击“文献管理”进入文献管理界面
- 点击“导入文献”进入文献导入界面
- 在弹出的表单中输入文献元信息
管理文献引用
- 点击”文献管理“进入文献管理界面
- 在文献预览中找到要编辑的文献，点击“管理引用”进入引用预览
- 在picker右侧“未引用”列表中选择要添加的引用文献，点击“添加”将其移入“引用”列表
- 在picker左侧“引用”列表中选择要添加的引用文献，点击“移除”将其移入“未引用”列表
编辑文献笔记
- 点击“文献管理”进入文献管理界面
- 在文献预览中找到要编辑的文献，点击“编辑笔记”进入笔记编辑页面
编辑路书
- 点击”编辑器“进入编辑器界面
- 在素材栏选择“创建路书”新建一篇路书
- 将素材栏中素材拖入编辑区，即可创建素材结点并自动创建引用连接
- 选择一个素材并点击添加连接，再选择另一个素材，即可创建前者指向后者的连接
功能描述与验收标准
功能 | 验收标准
- | -
简单文献管理 | - 文献CURD | 用户可以上传、编辑、移除文献
- 文献引用管理 | 用户可以为每篇文献设置引用关系
文献笔记 | - 笔记编辑 | 用户可以编辑、更新任意文献笔记
路书编辑 | - 路书CURD | 用户可以创建、编辑、移除路书
- 添加素材 | 用户可以将素材添入路书
- 自动引用连接 | 添加素材后所有素材间已存在的引用关系可以自动添加并显示
- 显示笔记 | 添加文献后可以正确展示文献笔记
- 连接CURD | 可以为所选素材间添加连接；可以移除所选连接；可以编辑已有连接，修改其颜色等属性
- 保存编辑 | 路书编辑后可以自动保存，重新加载时可以完全恢复上一次编辑
路书展示 | 路书可以以只读形式展示，这个模式下不允许任何修改
