[知識路書]功能規格說明書

這是一篇軟工課程博客

項目	內容
課程：北航-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便可，能夠參考這個示例

主流交互步驟

導入文獻

1. 點擊「文獻管理」進入文獻管理界面
2. 點擊「導入文獻」進入文獻導入界面
3. 在彈出的表單中輸入文獻元信息

管理文獻引用

1. 點擊」文獻管理「進入文獻管理界面
2. 在文獻預覽中找到要編輯的文獻，點擊「管理引用」進入引用預覽
3. 在picker右側「未引用」列表中選擇要添加的引用文獻，點擊「添加」將其移入「引用」列表
4. 在picker左側「引用」列表中選擇要添加的引用文獻，點擊「移除」將其移入「未引用」列表

編輯文獻筆記

1. 點擊「文獻管理」進入文獻管理界面
2. 在文獻預覽中找到要編輯的文獻，點擊「編輯筆記」進入筆記編輯頁面

編輯路書

1. 點擊」編輯器「進入編輯器界面
2. 在素材欄選擇「建立路書」新建一篇路書
3. 將素材欄中素材拖入編輯區，便可建立素材結點並自動建立引用鏈接
4. 選擇一個素材並點擊添加鏈接，再選擇另外一個素材，便可建立前者指向後者的鏈接

功能描述與驗收標準

功能	驗收標準
簡單文獻管理
- 文獻CURD	用戶能夠上傳、編輯、移除文獻
- 文獻引用管理	用戶能夠爲每篇文獻設置引用關係
文獻筆記
- 筆記編輯	用戶能夠編輯、更新任意文獻筆記
路書編輯
- 路書CURD	用戶能夠建立、編輯、移除路書
- 添加素材	用戶能夠將素材添入路書
- 自動引用鏈接	添加素材後全部素材間已存在的引用關係能夠自動添加並顯示
- 顯示筆記	添加文獻後能夠正確展現文獻筆記
- 鏈接CURD	能夠爲所選素材間添加鏈接；能夠移除所選鏈接；能夠編輯已有鏈接，修改其顏色等屬性
- 保存編輯	路書編輯後能夠自動保存，從新加載時能夠徹底恢復上一次編輯
路書展現	路書能夠以只讀形式展現，這個模式下不容許任何修改