如何撰寫php軟體開發文檔

如何寫php軟體開發文件?

#1標題
軟體系統名稱與識別碼
模組名稱和識別碼（如果本卷宗包含多於一個的模組，則用這組模組的功能標識代替模組名）
程式編製員簽章
卷宗的修改文字序號
修改完成日期
卷宗序號（說明本卷宗在整個卷宗中的序號）
編排日期（說明整個卷宗最近的一次編排日期）

2模組開發情況表

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

以上是如何撰寫php軟體開發文檔的詳細內容。更多資訊請關注PHP中文網其他相關文章！