如何編寫php軟件開發(fā)文檔

如何編寫php軟件開發(fā)文檔?

1標(biāo)題
軟件系統(tǒng)名稱和標(biāo)識(shí)符
模塊名稱和標(biāo)識(shí)符（如果本卷宗包含多于一個(gè)的模塊，則用這組模塊的功能標(biāo)識(shí)代替模塊名）
程序編制員簽名
卷宗的修改文本序號(hào)
修改完成日期
卷宗序號(hào)（說(shuō)明本卷宗在整個(gè)卷宗中的序號(hào)）
編排日期（說(shuō)明整個(gè)卷宗最近的一次編排日期）

2模塊開發(fā)情況表

3功能說(shuō)明
扼要說(shuō)明本模塊（或本組模塊）的功能，主要是輸入、要求的處理、輸出。可以從系統(tǒng)設(shè)計(jì)說(shuō)明書中摘錄。同時(shí)列出在軟件需求說(shuō)明書中對(duì)這些功能的說(shuō)明的章、條、款。
4設(shè)計(jì)說(shuō)明
說(shuō)明本模塊（或本組模塊）的設(shè)計(jì)考慮，包括：
a． 在系統(tǒng)設(shè)計(jì)說(shuō)明書中有關(guān)對(duì)本模塊（或本組模塊）設(shè)計(jì)考慮的敘述，包括本模塊在軟件系統(tǒng)中所處的層次，它同其他模塊的接口；
b． 在程序設(shè)計(jì)說(shuō)明書中有關(guān)對(duì)本模塊（或本組模塊）的設(shè)計(jì)考慮，包括本模塊的算法、處理流程、牽涉到的數(shù)據(jù)文卷設(shè)計(jì)限制、驅(qū)動(dòng)方式和出錯(cuò)信息等；
c． 在編制目前已通過(guò)全部測(cè)試的源代碼時(shí)實(shí)際使用的設(shè)計(jì)考慮。
5原代碼清單
要給出所產(chǎn)生的本模塊（或本組模塊）的第一份無(wú)語(yǔ)法錯(cuò)的源代碼清單以及已通過(guò)全部測(cè)試的當(dāng)前有效的源代碼清單。
6測(cè)試說(shuō)明
說(shuō)明直接要經(jīng)過(guò)本模塊（或本組模塊）的每一項(xiàng)測(cè)試，包括這些測(cè)試各自的標(biāo)識(shí)符和編號(hào)、進(jìn)行這些測(cè)試的目的、所用的配置和輸入、預(yù)期的輸出及實(shí)際的輸出。
7復(fù)審的結(jié)論
把實(shí)際測(cè)試的結(jié)果，同軟件需求說(shuō)明書、系統(tǒng)設(shè)計(jì)說(shuō)明書、程序設(shè)計(jì)說(shuō)明書中規(guī)定的要求進(jìn)行比較和給出結(jié)論。