|
1 針對性
文檔編制以前應分清讀者對象，按不同的類型、不同層次的讀者，決定怎樣適應他們的需要。
① 對于面向管理人員和用戶的文檔，不應像開發(fā)文檔(面向軟件開發(fā)人員)那樣過多地使用軟件的專業(yè)術(shù)語。 難以避免使用的詞匯，應在文檔中添加詞匯表，進行解釋。
② 開發(fā)文檔使用的專業(yè)詞匯未被廣泛認知的，應添加注釋進行說明。
③ 縮寫詞未被廣泛認知的，應在其后跟上完整的拼寫。
2 正確性
① 沒有錯字，漏字。
② 文檔間引用關(guān)系正確。
③ 文檔細節(jié)(Title/History)正確。
3 準確性
① 意思表達準確清晰，沒有二義性。
② 正確使用標點符號，避免產(chǎn)生歧義。
4 完整性
① 意思表達完整，能找到主語、謂語、賓語，沒有省略主語，特別是謂語
② 一句話中不能出現(xiàn)幾個動詞一個賓語的現(xiàn)象。
③ 不遺漏要求和必需的信息。
5 簡潔性
① 盡量不要采用較長的句子來描述，無法避免時，應注意使用正確的標點符號。
② 簡潔明了，不累贅冗余，每個意思只在文檔中表達一次。
③ 每個陳述語句，只表達一個意思。
④ 力求簡明，如有可能，配以適當?shù)膱D表，以增強其清晰性。
6 統(tǒng)一性
① 統(tǒng)一采用專業(yè)術(shù)語和項目規(guī)定的術(shù)語集。
② 同一個意思和名稱，前后描述的用語要一致。
③ 文檔前后使用的字體要統(tǒng)一。
④ 同一課題若干文檔內(nèi)容應該協(xié)調(diào)一致，沒有矛盾。
7 易讀性
① 文字描述要通俗易懂。
② 前后文關(guān)聯(lián)詞使用恰當。
③ 文檔變更內(nèi)容用其他顏色與上個版本區(qū)別開來。
④ 測試步驟要采用列表的方式，用1)、2)、3)…等數(shù)字序號標注。 | 
