軟件文檔寫(xiě)作注意點(diǎn)

不需要把問(wèn)題的來(lái)龍去脈寫(xiě)的很清楚，也就是不需要起因、發(fā)展、情節(jié)；
專(zhuān)業(yè)術(shù)語(yǔ)必須有解釋部分；
盡量使用短句；
對(duì)文檔做好章節(jié)編排，編制好章節(jié)號(hào)；
章節(jié)名稱必須能夠概括本章節(jié)的主要內(nèi)容，以便按章節(jié)名稱查找信息；
注意文檔定義的讀者，考慮讀者對(duì)于文檔相關(guān)內(nèi)容的必須背景的了解；

文檔必須及時(shí)更新，以確保內(nèi)容不是錯(cuò)誤的，與當(dāng)前的實(shí)際相符合；
 
注意：軟件文檔是應(yīng)用文的一種，需要有應(yīng)用文的特點(diǎn)：
1、特定的對(duì)象和寫(xiě)作目的
2、有較為固定的寫(xiě)作格式
3、有較強(qiáng)的時(shí)效性；
4、語(yǔ)言要樸實(shí)、簡(jiǎn)明、準(zhǔn)確
 
另外并不是每個(gè)人的行文能力都達(dá)到了寫(xiě)出好文檔的水平，但是都是可以培養(yǎng)的，更何況軟件文檔有固定的格式。