如何編寫php軟件開發文檔

如何編寫php軟件開發文檔?

1標題
軟件系統名稱和標識符
模塊名稱和標識符（如果本卷宗包含多于一個的模塊，則用這組模塊的功能標識代替模塊名）
程序編制員簽名
卷宗的修改文本序號
修改完成日期
卷宗序號（說明本卷宗在整個卷宗中的序號）
編排日期（說明整個卷宗最近的一次編排日期）

2模塊開發情況表

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