對(duì)于嵌入式軟件來(lái)說(shuō),方案設(shè)計(jì)時(shí),常常會(huì)寫詳細(xì)設(shè)計(jì)文檔。比如我這一周,有兩天時(shí)間都在寫文檔。
我覺得詳細(xì)設(shè)計(jì)文檔,能說(shuō)清楚設(shè)計(jì)的內(nèi)容就差不多了,可以用流程圖、思維導(dǎo)圖、框圖來(lái)做說(shuō)明,配合少許文字。必要的時(shí)候,可以定義出一些對(duì)外服務(wù)的接口,或者備注需要外部模塊提供的接口。
1引言
1.1編寫目的
該文檔在概要設(shè)計(jì)的基礎(chǔ)上,進(jìn)一步的細(xì)化系統(tǒng)結(jié)構(gòu),展示了軟件結(jié)構(gòu)的圖標(biāo),物理設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)、及算法設(shè)計(jì)、詳細(xì)的介紹了系統(tǒng)各個(gè)模塊是如何實(shí)現(xiàn)的,包括涉及到的算法,邏輯流程等。 預(yù)期的讀者:程序員
1.2背景
a. 待開發(fā)軟件系統(tǒng)的名稱:機(jī)房收費(fèi)系統(tǒng) b. 項(xiàng)目的任務(wù)提出者:張老板 c. 項(xiàng)目的開發(fā)者:齊先生 d. 項(xiàng)目的用戶:志晟網(wǎng)絡(luò)的全體用戶 e. 運(yùn)行該軟件的計(jì)算站(中心):志晟網(wǎng)絡(luò)全體硬件設(shè)備
1.3定義
系統(tǒng)結(jié)構(gòu):對(duì)系統(tǒng)整體布局的宏觀的描述 算法:對(duì)于程序內(nèi)部流程計(jì)算的邏輯表達(dá)方式。
1.4參考資料
列出有關(guān)的參考資料,如: a. 詳細(xì)設(shè)計(jì)說(shuō)明書(G8567——88) b. 《軟件工程概述》 李存珠編著 南京大學(xué)計(jì)算機(jī)系出版 2001年8月
2程序系統(tǒng)的結(jié)構(gòu)
3一般用戶設(shè)計(jì)說(shuō)明
3.1程序描述
該程序指對(duì)學(xué)生的上下機(jī)情況及學(xué)生信息進(jìn)行查看,沒有涉及管理功能,只是將學(xué)生的信息輸入數(shù)據(jù)庫(kù),經(jīng)過(guò)系統(tǒng)處理后得到新的數(shù)據(jù)信息。
3.2功能
3.3性能
3.3.1精度
軟件的輸入精度:只保留整數(shù)部分 軟件的輸出精度:只保留整數(shù)部分 傳輸過(guò)程中的精度:只保留整數(shù)部分
3.3.2靈活性
A.運(yùn)行環(huán)境的變化:該軟適用于現(xiàn)在流行的操作系統(tǒng)。 B.精度和有效時(shí)限的變化:因不同情況而變化。 C.計(jì)劃的變化和改進(jìn):根據(jù)用戶的需求隨時(shí)軟件做出更新和升級(jí)。
3.3.3時(shí)間特性的要求。
相應(yīng)時(shí)間:0.5s內(nèi) 更新處理時(shí)間:0.5s內(nèi) 數(shù)據(jù)的更換和傳送時(shí)間:1s內(nèi)
3.4輸人項(xiàng)
3.5輸出項(xiàng)
3.6算法
時(shí)間差=下機(jī)時(shí)間-上機(jī)時(shí)間 金額按照基本數(shù)據(jù)設(shè)定和時(shí)間差判斷金額的計(jì)算方法
3.7流程邏輯
3.8接口
3.9存儲(chǔ)分配
3.10注釋設(shè)計(jì)
說(shuō)明準(zhǔn)備在本程序中安排的注釋,如: a. 在模塊首部注釋說(shuō)明模塊開始編寫時(shí)間、編寫人員及其基本功能 b. 在變量聲明階段,大概說(shuō)明變量的類型和用途 c. 在判斷、循環(huán)或者順序枝分點(diǎn)上注釋說(shuō)明程序代碼的功能
3.11限制條件
必須保證程序正常的連接到服務(wù)器
3.12測(cè)試計(jì)劃
測(cè)試用例:選取有代表性的數(shù)據(jù),避免使用窮舉法 測(cè)試方法:使用白盒測(cè)試法,語(yǔ)句覆蓋、判定覆蓋、條件覆蓋等操作。
3.13尚未解決的問(wèn)題
暫無(wú)
4操作員設(shè)計(jì)說(shuō)明
4.1程序描述
該程序指對(duì)學(xué)生的上下機(jī)情況及學(xué)生信息進(jìn)行查看,包括注冊(cè)、充值、修改信息、退卡以及對(duì)操作員工作記錄的查詢工作。一般用戶沒有此權(quán)限。
4.2功能
4.3性能
4.3.1精度
軟件的輸入精度:只保留整數(shù)部分 軟件的輸出精度:只保留整數(shù)部分 傳輸過(guò)程中的精度:只保留整數(shù)部分
4.3.2靈活性
A.運(yùn)行環(huán)境的變化:該軟適用于現(xiàn)在流行的操作系統(tǒng)。 B.精度和有效時(shí)限的變化:因不同情況而變化。 C.計(jì)劃的變化和改進(jìn):根據(jù)用戶的需求隨時(shí)軟件做出更新和升級(jí)。
4.3.3時(shí)間特性的要求。
相應(yīng)時(shí)間:0.5s內(nèi) 更新處理時(shí)間:0.5s內(nèi) 數(shù)據(jù)的更換和傳送時(shí)間:1s內(nèi)
4.4輸人項(xiàng)
4.5輸出項(xiàng)
4.6算法
總金額=剩余金額+充值金額 剩余金額=總金額-消費(fèi)金額 退還金額=剩余金額-消費(fèi)金額
4.7流程邏輯
4.8接口
4.9存儲(chǔ)分配
4.10注釋設(shè)計(jì)
說(shuō)明準(zhǔn)備在本程序中安排的注釋,如: d. 在模塊首部注釋說(shuō)明模塊開始編寫時(shí)間、編寫人員及其基本功能 e. 在變量聲明階段,大概說(shuō)明變量的類型和用途 f. 在判斷、循環(huán)或者順序枝分點(diǎn)上注釋說(shuō)明程序代碼的功能
4.11限制條件
必須保證程序正常的連接到服務(wù)器
4.12測(cè)試計(jì)劃
主要在注冊(cè)模塊、注意選取不同的數(shù)據(jù),確保輸入數(shù)據(jù)合法,符合規(guī)定的范圍 對(duì)于充值、退卡以及信息維護(hù)模塊,舉例測(cè)試并觀察測(cè)試結(jié)果是否符合邏輯規(guī)律。
4.13尚未解決的問(wèn)題
暫無(wú)
5管理員設(shè)計(jì)說(shuō)明
5.1程序描述
管理員模塊主要是對(duì)整個(gè)系統(tǒng)的管理,包括對(duì)操作員的查看和管理,用戶的添加和刪除,系統(tǒng)基本數(shù)據(jù)的設(shè)定以及結(jié)賬工作。
5.2功能
5.3性能
5.3.1精度
軟件的輸入精度:只保留整數(shù)部分 軟件的輸出精度:只保留整數(shù)部分 傳輸過(guò)程中的精度:只保留整數(shù)部分
5.3.2靈活性
A.運(yùn)行環(huán)境的變化:該軟適用于現(xiàn)在流行的操作系統(tǒng)。 B.精度和有效時(shí)限的變化:因不同情況而變化。 C.計(jì)劃的變化和改進(jìn):根據(jù)用戶的需求隨時(shí)軟件做出更新和升級(jí)。
5.3.3時(shí)間特性的要求。
相應(yīng)時(shí)間:0.5s內(nèi) 更新處理時(shí)間:0.5s內(nèi) 數(shù)據(jù)的更換和傳送時(shí)間:1s內(nèi)
5.4輸人項(xiàng)
5.5輸出項(xiàng)
5.6算法
總金額=剩余金額+充值金額 剩余金額=總金額-消費(fèi)金額 退還金額=剩余金額-消費(fèi)金額
5.7流程邏輯
5.8接口
5.9存儲(chǔ)分配
5.10注釋設(shè)計(jì)
說(shuō)明準(zhǔn)備在本程序中安排的注釋,如: a. 在模塊首部注釋說(shuō)明模塊開始編寫時(shí)間、編寫人員及其基本功能 b. 在變量聲明階段,大概說(shuō)明變量的類型和用途 c. 在判斷、循環(huán)或者順序枝分點(diǎn)上注釋說(shuō)明程序代碼的功能
5.11限制條件
必須保證程序正常的連接到服務(wù)器
5.12測(cè)試計(jì)劃
A.主要在結(jié)賬模塊,注意選取不同的時(shí)間段,觀察結(jié)賬是否符合系統(tǒng)邏輯運(yùn)算法則 B.對(duì)于添加刪除用戶模塊,舉例測(cè)試并觀察測(cè)試結(jié)果是否符合邏輯規(guī)律 C.最后是日結(jié)賬單和周接賬單,檢驗(yàn)報(bào)表是否正確,能否正確預(yù)覽和打印。
審核編輯 :李倩
-
嵌入式
+關(guān)注
關(guān)注
5141文章
19537瀏覽量
315139 -
服務(wù)器
+關(guān)注
關(guān)注
13文章
9699瀏覽量
87308 -
數(shù)據(jù)結(jié)構(gòu)
+關(guān)注
關(guān)注
3文章
573瀏覽量
40606
原文標(biāo)題:嵌入式軟件詳細(xì)設(shè)計(jì)怎么寫?
文章出處:【微信號(hào):mcu168,微信公眾號(hào):硬件攻城獅】歡迎添加關(guān)注!文章轉(zhuǎn)載請(qǐng)注明出處。
發(fā)布評(píng)論請(qǐng)先 登錄
嵌入式開發(fā)入門指南:從零開始學(xué)習(xí)嵌入式
嵌入式軟件行業(yè)增長(zhǎng)驅(qū)動(dòng)因素
嵌入式主板開發(fā)詳細(xì)指南

嵌入式系統(tǒng)開發(fā)圣經(jīng)【干貨】
嵌入式機(jī)器學(xué)習(xí)的應(yīng)用特性與軟件開發(fā)環(huán)境

嵌入式系統(tǒng)開發(fā)與硬件的關(guān)系 嵌入式系統(tǒng)開發(fā)常見問(wèn)題解決
一文了解嵌入式軟件開發(fā)的對(duì)象

AM6254開發(fā)常見問(wèn)題之「燒寫問(wèn)題排查」——飛凌嵌入式

什么是嵌入式?一文讀懂嵌入式主板
嵌入式主板是什么意思?嵌入式主板全面解析
EsDA,一站式嵌入式軟件

嵌入式系統(tǒng)中的實(shí)時(shí)操作系統(tǒng)
嵌入式軟件開發(fā)與AI整合

嵌入式開發(fā)前景怎么樣?

評(píng)論