文檔應(yīng)該包括兩大部分，一部分是清晰的代碼結(jié)構(gòu)和注釋，比如Concurrent API就是這樣，還有一部分是文字文檔，包括三個(gè)小部分：一是開(kāi)發(fā)文檔，應(yīng)該講架構(gòu)和功能；二是索引文檔，詳細(xì)介紹功能和參數(shù)，三是用戶文檔，包括安裝和使用說(shuō)明
文檔最困難的莫過(guò)于版本的一致性，當(dāng)軟件升級(jí)后，一些obsolete的內(nèi)容和新的feature很難同步。要是架構(gòu)發(fā)生了變化，那就更困難了。一般document team都不是太精于技術(shù)，所以也會(huì)產(chǎn)生一些問(wèn)題。
只能說(shuō)任何事物永遠(yuǎn)都有改進(jìn)的空間，但是同樣也永遠(yuǎn)沒(méi)有達(dá)到完美的程度
@2008 楊一. 版權(quán)所有. 保留所有權(quán)利