一個典型的詳細設計說明書的框架如下所示:
1、引言
1.1、編寫目的
說明編寫詳細說明書的目的,並說明所面向的讀者對象。
1.2、項目背景
包括項目的來源和主管部門等。
1.3、定義
列出文檔中所用的專門術語的定義和縮寫詞的原意。
1.4、參考資料
類出有關資料的作者、標題、編號、發表日期、出版單位或資料來源。它可包括:項目計劃任務書、合同或批文、項目開發計劃、需求規格說明書、總體設計說明書、測試計劃、用戶操作手冊、文檔中所引用的其他資料、軟件開發標準或規範。
2、總體設計
2.1、需求概述
2.2、軟件結構
給出軟件系統的結構圖
3、程序描述
對每個模塊給出以下說明:
3.1、功能
3.2、輸入項目
3.3、輸出項目
3.4、算法
給出模塊所選用的算法
3.6、程序邏輯
詳細描述模塊實現的算法
3.7、接口
3.8、存儲分配
3.9、限制條件
3.10、測試要點
給出測試模塊的主要測試要求。