- 前端架構:從入門到微前端
- 黃峰達
- 376字
- 2019-09-21 00:53:51
3.9 可編輯文檔庫:提升協作性
繪制完項目架構圖后,我們就需要找到一個可編輯的文檔中心。同樣的,我們優先關注于其是否可以版本化、圖形可視化,以及追蹤歷史修改。它可以是:
◎ 可以記錄版本歷史的維基(Wiki)軟件。
◎ 專業的協作工具,比如Atlassian的Confluence。
◎ 基于Git+Markdown的代碼管理工具。
它應該還能支持以下功能:實時多人編輯、內容索引、圖形可視化、實時搜索、打標簽、檢查清單、導入導出等。
我們之所以對于編輯的文檔中心有這樣的要求,原因在于遇到過太多的“坑”。過去接收的二進制文檔,諸如word等,太容易過期了,它們不能進行版本管理,討論問題的時候,需要進一步確認。如果中間文檔有更新,我們需要重新獲取一份文檔。在反復溝通之后,我們會產生對文檔價值的懷疑。
一個好的文檔中心能夠從某種程度上解決這個問題。但是,它并不能解決所有的問題。對于一個長期的項目而言,筆者更希望這個文檔是放置在代碼倉庫中的。