軟件文檔寫作注意點

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

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