dokiwiki vol.1
工程師大致上來說, 是不喜歡寫文件的
寫了又沒人看, 而且做完以後, 該怎麼動都在腦袋裡, 寫文件等於是多餘的工作
我想任何人都不喜歡這種沒gain的事
在工作流程裡, 很自然會有不少副產出, 比如找同事討論, 在白板上的塗鴉
在紙上隨手記下的筆記, 這些其實就很夠拿來當作文件
我想文件的真正用途, 是讓人(包括自己)了解設計, 任何有意義的線索都值得保留
我不推保留紙張當作文件, 因為順手寫下的塗鴉, 很容易不小心被當作垃圾丟掉;
好在現在手機都有內建相機, 順手拍下來, 再用小畫家編輯一下, 重點就很清楚
形式不是重點, 而且他不應該難以製作 (比如強迫用visio畫流程圖)
撰寫文件的第一步, 就是從工作流程裡, 抽取本來就會產生的副產品作為素材
下一階段是, 這些素材要用什麼東西組織起來
一般我們會想到word/excel這類的工具, 其實這些工具有幾個很顯著的缺點
- 難以編輯, 電腦一定要有word/excel
- 難以管理, 一定得用資料夾分門別類, 偏偏分類是很麻煩的事
- 無法搜索, 如果有一堆文件, 要在一堆word/excel裡尋找是很麻煩的事
- 難以維護版本, 難以多人一起維護一份文件
我的建議是使用WIKI, WIKI架在server上, 編輯的, 看到的永遠是最新版
只要有任何想法, 透過瀏覽器隨時可以編輯文件, 每個頁面也可以很容易內嵌文件, 檔案, 連結
因為WIKI容易編輯的特性, 大幅度降低撰寫文件的"心理負擔"
比較容易做到當設計出來時, 也有一定數量的文件
目前在網路上, 最著名的WIKI是維基百科, 這個WIKI使用MediaWIKI寫成
您可以連到維基百科, 觀察他的效果
如果是個人, 小團隊使用, 建議使用簡單一點WIKI
- 不要使用資料庫當作backend, 我實在不懂資料庫
- 好安裝, 可以在Win32上面跑
最後我挑了dokuwiki, 這個wiki能完全滿足我們的需求
這個wiki system我在2009第一次架設, 最近重新又弄了一個
操作的流暢度和介面都有相當的改善
下一篇我會講, 大概的安裝方法
留言