嵌入式軟件詳細設計怎么寫?

對于嵌入式軟件來說，方案設計時，常常會寫詳細設計文檔。比如我這一周，有兩天時間都在寫文檔。

我覺得詳細設計文檔，能說清楚設計的內容就差不多了，可以用流程圖、思維導圖、框圖來做說明，配合少許文字。必要的時候，可以定義出一些對外服務的接口，或者備注需要外部模塊提供的接口。

1引言

1.1編寫目的

該文檔在概要設計的基礎上，進一步的細化系統結構，展示了軟件結構的圖標，物理設計、數據結構設計、及算法設計、詳細的介紹了系統各個模塊是如何實現的，包括涉及到的算法，邏輯流程等。 預期的讀者：程序員

1.2背景

a. 待開發(fā)軟件系統的名稱：機房收費系統 b. 項目的任務提出者：張老板 c. 項目的開發(fā)者：齊先生 d. 項目的用戶：志晟網絡的全體用戶 e. 運行該軟件的計算站（中心）：志晟網絡全體硬件設備

1.3定義

系統結構：對系統整體布局的宏觀的描述 算法：對于程序內部流程計算的邏輯表達方式。

1.4參考資料

列出有關的參考資料，如： a． 詳細設計說明書（G8567——88） b． 《軟件工程概述》 李存珠編著 南京大學計算機系出版 2001年8月

2程序系統的結構

3一般用戶設計說明

3.1程序描述

該程序指對學生的上下機情況及學生信息進行查看，沒有涉及管理功能，只是將學生的信息輸入數據庫，經過系統處理后得到新的數據信息。

3.2功能

3.3性能

3.3.1精度

軟件的輸入精度：只保留整數部分 軟件的輸出精度：只保留整數部分 傳輸過程中的精度:只保留整數部分

3.3.2靈活性

A．運行環(huán)境的變化：該軟適用于現在流行的操作系統。 B．精度和有效時限的變化：因不同情況而變化。 C．計劃的變化和改進：根據用戶的需求隨時軟件做出更新和升級。

3.3.3時間特性的要求。

相應時間：0.5s內 更新處理時間：0.5s內 數據的更換和傳送時間：1s內

3.4輸人項

3.5輸出項

3.6算法

時間差=下機時間-上機時間 金額按照基本數據設定和時間差判斷金額的計算方法

3.7流程邏輯

3.8接口

3.9存儲分配

3.10注釋設計

說明準備在本程序中安排的注釋，如： a． 在模塊首部注釋說明模塊開始編寫時間、編寫人員及其基本功能 b． 在變量聲明階段，大概說明變量的類型和用途 c． 在判斷、循環(huán)或者順序枝分點上注釋說明程序代碼的功能

3.11限制條件

必須保證程序正常的連接到服務器

3.12測試計劃

測試用例：選取有代表性的數據，避免使用窮舉法 測試方法：使用白盒測試法，語句覆蓋、判定覆蓋、條件覆蓋等操作。

3.13尚未解決的問題

暫無

4操作員設計說明

4.1程序描述

該程序指對學生的上下機情況及學生信息進行查看，包括注冊、充值、修改信息、退卡以及對操作員工作記錄的查詢工作。一般用戶沒有此權限。

4.2功能

4.3性能

4.3.1精度

軟件的輸入精度：只保留整數部分 軟件的輸出精度：只保留整數部分 傳輸過程中的精度:只保留整數部分

4.3.2靈活性

A．運行環(huán)境的變化：該軟適用于現在流行的操作系統。 B．精度和有效時限的變化：因不同情況而變化。 C．計劃的變化和改進：根據用戶的需求隨時軟件做出更新和升級。

4.3.3時間特性的要求。

相應時間：0.5s內 更新處理時間：0.5s內 數據的更換和傳送時間：1s內

4.4輸人項

4.5輸出項

4.6算法

總金額=剩余金額+充值金額 剩余金額=總金額-消費金額 退還金額=剩余金額-消費金額

4.7流程邏輯

4.8接口

4.9存儲分配

4.10注釋設計

說明準備在本程序中安排的注釋，如： d． 在模塊首部注釋說明模塊開始編寫時間、編寫人員及其基本功能 e． 在變量聲明階段，大概說明變量的類型和用途 f． 在判斷、循環(huán)或者順序枝分點上注釋說明程序代碼的功能

4.11限制條件

必須保證程序正常的連接到服務器

4.12測試計劃

主要在注冊模塊、注意選取不同的數據，確保輸入數據合法，符合規(guī)定的范圍 對于充值、退卡以及信息維護模塊，舉例測試并觀察測試結果是否符合邏輯規(guī)律。

4.13尚未解決的問題

暫無

5管理員設計說明

5.1程序描述

管理員模塊主要是對整個系統的管理，包括對操作員的查看和管理，用戶的添加和刪除，系統基本數據的設定以及結賬工作。

5.2功能

5.3性能

5.3.1精度

軟件的輸入精度：只保留整數部分 軟件的輸出精度：只保留整數部分 傳輸過程中的精度：只保留整數部分

5.3.2靈活性

A．運行環(huán)境的變化：該軟適用于現在流行的操作系統。 B．精度和有效時限的變化：因不同情況而變化。 C．計劃的變化和改進：根據用戶的需求隨時軟件做出更新和升級。

5.3.3時間特性的要求。

相應時間：0.5s內 更新處理時間：0.5s內 數據的更換和傳送時間：1s內

5.4輸人項

5.5輸出項

5.6算法

總金額=剩余金額+充值金額 剩余金額=總金額-消費金額 退還金額=剩余金額-消費金額

5.7流程邏輯

5.8接口

5.9存儲分配

5.10注釋設計

說明準備在本程序中安排的注釋，如： a． 在模塊首部注釋說明模塊開始編寫時間、編寫人員及其基本功能 b． 在變量聲明階段，大概說明變量的類型和用途 c． 在判斷、循環(huán)或者順序枝分點上注釋說明程序代碼的功能

5.11限制條件

必須保證程序正常的連接到服務器

5.12測試計劃

A．主要在結賬模塊，注意選取不同的時間段，觀察結賬是否符合系統邏輯運算法則 B．對于添加刪除用戶模塊，舉例測試并觀察測試結果是否符合邏輯規(guī)律 C．最后是日結賬單和周接賬單，檢驗報表是否正確，能否正確預覽和打印。

審核編輯 ：李倩