關于軟件文檔,我的看法
文檔應該包括兩大部分,一部分是清晰的代碼結構和注釋,比如Concurrent API就是這樣,還有一部分是文字文檔,包括三個小部分:一是開發文檔,應該講架構和功能;二是索引文檔,詳細介紹功能和參數,三是用戶文檔,包括安裝和使用說明文檔最困難的莫過于版本的一致性,當軟件升級后,一些obsolete的內容和新的feature很難同步。要是架構發生了變化,那就更困難了。一般document team都不是太精于技術,所以也會產生一些問題。
只能說任何事物永遠都有改進的空間,但是同樣也永遠沒有達到完美的程度
@2008 楊一. 版權所有. 保留所有權利
posted on 2010-06-29 18:26 楊一 閱讀(327) 評論(0) 編輯 收藏 所屬分類: Other Tech