有關文檔的實用要求<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />
1. 文檔不僅僅是給客戶的，也是我們此次工程實施的經驗總結；
2. 文檔必須要實用，爲了客戶，也爲了我們自己！
怎麼樣的文檔纔算實用?
1. 目的明確
a) 文檔肯定是針對某類問題的說明，因此要求目的明確，針對性強。比如若僅是針對某個模塊其中一個版本的說明，則決不含糊其辭，而是在很明顯的地方與以說明，決不浪費使用者/讀者的時間。
2. 條理清晰
a) 儘可能地以讀者角度/思路來合理編排章節；
b) 講清楚：是什麼？爲什麼？怎麼做？等幾個問題，必要時還需要增加“誰？”“何時？何地？何種情況？”等一些問題。
3. 一致性
a) 在文中多次出現的有關內容，應該前後描述一致，不自相矛盾；
4. 內容充實
a) 就某個問題的描述，應該言之有物而不誇誇其談；
b) 若實在沒東西講，應該寫明“內容有待細化/補充”；
5. 可操作性
a) 如果文檔的特點是針對操作開展，則應該在內容的真實性、可驗證性上做足文章。讀者能夠根據文檔的提示一步步完成某項工作；
b) 文檔應該儘可能地提供可視化的圖片或其他媒體方式，以便內容直觀，更易於理解；
6. 體貼
a) 在文中出現對有關內容的引述，應該儘可能提供鏈接，以免讀者四處搜索遍尋不着；
