技術(shù)文檔說(shuō)明書的模板

1、XXXX系統(tǒng)2022年3月5日更新記錄創(chuàng)建日期原作者完成日期變更記錄變更日期變更人變更摘要目 錄第一章 前言- 3 -1.系統(tǒng)名稱- 3 -2.需求提出單位- 3 -3.內(nèi)容簡(jiǎn)介- 3 -4.參考資料- 3 -第二章 程序總體介紹- 4 -第三章 模塊清單列表- 5 -第四章 模塊開發(fā)技術(shù)文檔- 6 -1.XX模塊名稱- 6 -1.1. 模塊功能- 6 -1.2. 輸入輸出信息- 6 -1.3. 使用文件和表格- 6 -1.4. 模塊間接口- 7 -1.5. 模塊結(jié)構(gòu)圖或流程圖- 7 -1.6. 處理描述- 7 -1.7. 有關(guān)事項(xiàng)（根據(jù)具體情況決定有無(wú)此節(jié)）- 7 -1.8. 測(cè)試說(shuō)明- 7

2、 -1.9. 復(fù)審的結(jié)論- 8 -2.XX模塊名稱- 8 -第一章 前言1. 系統(tǒng)名稱指出方案/系統(tǒng)的名稱（中文全稱、簡(jiǎn)稱，英文全稱、簡(jiǎn)稱含版本號(hào)）。2. 需求提出單位指出用戶/需求提出部門的名稱。3. 內(nèi)容簡(jiǎn)介介紹本文檔的內(nèi)容、編寫情況、參加人員等。4. 參考資料列出引用參考的文件資料的名稱。第二章 程序總體介紹對(duì)所有程序作一個(gè)整體概括說(shuō)明。第三章 模塊清單列表模塊編號(hào)標(biāo)識(shí)名稱描述名稱語(yǔ)言用途編制者日期備注第四章 模塊開發(fā)技術(shù)文檔1. XX模塊名稱說(shuō)明：A. 模塊名稱和標(biāo)識(shí)符（如果本卷宗包含多于一個(gè)的模塊，則用這組模塊的功能標(biāo)識(shí)代替模塊名） B. 程序編制員簽名 C. 卷宗的修改文本序號(hào) D

3、. 修改完成日期 1.1. 模塊功能扼要說(shuō)明本模塊（或本組模塊）的功能，主要是輸入、要求的處理、輸出?？梢詮南到y(tǒng)設(shè)計(jì)說(shuō)明書中摘錄。同時(shí)列出在軟件需求說(shuō)明書中對(duì)這些功能的說(shuō)明的章、條、款。1.2. 輸入輸出信息本模塊處理的所有輸入數(shù)據(jù)格式（包括數(shù)據(jù)項(xiàng)的名稱、標(biāo)識(shí)和位數(shù)等）及處理后的返回信息或輸出數(shù)據(jù)格式等，須詳細(xì)說(shuō)明。1.3. 使用文件和表格說(shuō)明：A. 本模塊處理過(guò)程中所用到的文件名、訪問(wèn)方式等；B. 所用到的內(nèi)存表格及參考或更新方式等予以說(shuō)明；C. 若文件和表格為本程序?qū)Ｓ?，須寫出具體格式。1.4. 模塊間接口本模塊有調(diào)用其它模塊或本模塊時(shí)，須指明調(diào)用與非調(diào)用的關(guān)系。包括調(diào)用模塊名，被調(diào)用模塊

4、的入口名以及參數(shù)的使用方法。1.5. 模塊結(jié)構(gòu)圖或流程圖用結(jié)構(gòu)化的程序設(shè)計(jì)要求畫出本程序處理的流程圖或結(jié)構(gòu)圖，并要詳細(xì)描述各層次的關(guān)系及必要的圖解。1.6. 處理描述說(shuō)明：A. 用文字?jǐn)⑹龅姆椒ǎ瑢?duì)本模塊的處理步驟和方法很詳盡的描述(包括所用到的計(jì)算公式和要求的計(jì)算精度等)；B. 指出本模塊的有關(guān)限制；C. 要求詳細(xì)描述本模塊在不正常情況下所做的各種特殊處理。（包括出錯(cuò)代碼等）。1.7. 有關(guān)事項(xiàng)（根據(jù)具體情況決定有無(wú)此節(jié)）主要說(shuō)明本程序操作方法，包括何時(shí)啟動(dòng)，啟動(dòng)命令處理中有哪些顯示和應(yīng)答要求等，以及其它有關(guān)的事項(xiàng)在此逐一說(shuō)明。1.8. 測(cè)試說(shuō)明說(shuō)明直接要經(jīng)過(guò)本模塊（或本組模塊）的每一項(xiàng)測(cè)試，包括這些測(cè)試各自的標(biāo)識(shí)符和編號(hào)、進(jìn)行這些測(cè)試的目的、所用的配置和輸入、預(yù)期的輸出及實(shí)際的輸出。1.9. 復(fù)審的結(jié)論把實(shí)際測(cè)試的結(jié)果，同軟