嵌入式專業(yè)項目文檔模板

1、wat f密級組號湖南科技職業(yè)學(xué)院軟件學(xué)院項目文檔項 口題口 系部專業(yè)學(xué)生姓名指導(dǎo)老師20xx年xx月項目文檔編寫模板文檔信息文檔名稱：項目文檔編寫模板負責(zé)人:xxx文檔版本編號：tech-spec-docu密級：普通文檔版本日期：2008-9-21起草人:起草日期：2008-9-21復(fù)審人:復(fù)審日期：任務(wù)分配表來自from日期電話/傳真xxx2008-9-211232模塊名稱負責(zé)人截止日期完成日期版本記錄版本編號版本日期修改者說明1.02008-9-21xxx草案目錄%1 軟件需求說明書（軟件計劃書，確定軟件的總體功能）11.1 弓i言11.2 業(yè)務(wù)流程整體說明（使用業(yè)務(wù)語言）11.3 特殊

2、說明11.4 原始資料1%1 需求分析報告32.1 引言32.2 任務(wù)概述32.3 功能需求32.4 性能需求32.5 運行環(huán)境描述42.6 其他需求4%1 軟件設(shè)計書（詳細設(shè)計說明書，建立軟件結(jié)構(gòu)）53.1 引言53.2 碩件結(jié)構(gòu)設(shè)計53.3 軟件結(jié)構(gòu)設(shè)計53.4 數(shù)據(jù)結(jié)構(gòu)設(shè)計53.5 硬件描述53.5.1 模塊 153.5.2 模塊 263.5.3 模塊 n63.6 程序描述63.6.1 模塊 173.6.2 模塊 273.6.3 模塊 n8%1 程序設(shè)計說明書91. 引言92. 系統(tǒng)電路圖錯誤！未定義書簽。3. 各功能核心代碼和界面說明91. 功能一92. 功能二93. 功能 n9%1

3、軟件測試說明書10引言10計劃10測試項目說明10測試計劃執(zhí)行情況10評價1（）%1 用戶手冊12弓丨呂12系統(tǒng)功能介紹12運行環(huán)境說明12運行前的準備12輸入輸出說明和操作說明12安全與保密13常見問題的處理13附錄：安裝與初始化（必須提供）13-軟件需求說明書（軟件計劃書，確定軟件的總體功能）1.1引言 編寫m的（闡明編寫需求說明書的目的） 項冃背景（應(yīng)包括：項冃的委托單位、開發(fā)單位和主管部門;該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）1.2業(yè)務(wù)流程整體說明（使用業(yè)務(wù)語言）總體流程圖總體流程圖的文字說明子流程圖1-子流程圖1 的文字說明子流程圖1中組成部分1詳細描述子流程圖2子流程圖2 的文字說明子流

4、程圖1中組成部分2詳細描述子流程圖2中組成部分1詳細描述子流程圖2中組成部分2詳細描述業(yè)務(wù)人員首先應(yīng)對業(yè)務(wù)有一個總體流程圖，同時輔以文字說明。如果總的流程圖的各個 組成部分述可以細分的話，應(yīng)繼續(xù)用了流程圖的形式對它的各組成部分進行說明并輔以文字 說明，直到流程圖的各個組成部分的業(yè)務(wù)步驟不可再分為止。例如代理錄入訂單，在詳細描 述中應(yīng)包括以下內(nèi)容：訂單的詳細信息；代理編號（長度要求，需耍代理手工選擇）；訂單 號（長度要求、需要代理手工輸入）1.3特殊說明需要特殊說明的一些問題，例如本系統(tǒng)與現(xiàn)有具他軟件系統(tǒng)的關(guān)系等。1.4原始資料bookmark41 資料收集：應(yīng)收集所有與業(yè)務(wù)需求相關(guān)的原始資料，

5、為后續(xù)工作（如：需求分析等） 做準備。bookmark41 原有業(yè)務(wù)流程概述：對原有業(yè)務(wù)流程進行說明（采取流程圖方式）bookmark41 原始單據(jù)、原始報表等：以列表的方式列出原始資料的名稱，而h要與原冇業(yè)務(wù)流 程概述的內(nèi)容相對照，并將實際的原始資料附在業(yè)務(wù)分析書的后面。原始資料名稱對應(yīng)于原冇業(yè)務(wù)流程概述的哪一部分內(nèi)容需求分析報告2.1引言bookmark41 編寫冃的針對軟件需求說明書提出的需求做進一步分析，詳細定義用戶耍求，為軟件設(shè)計提 供必要的指導(dǎo)。2.2任務(wù)概述目標敘述該項軟件開發(fā)的意圖、應(yīng)用目標、作用范圍以及該軟件的背景資料。解釋被開 發(fā)軟件與其他冇關(guān)軟件z間的關(guān)系。如果木軟件是一

6、個獨立的軟件，而全部內(nèi)容 自含，則說明這一點。如果定義的產(chǎn)品是一個更人系統(tǒng)的一個組成部分，則應(yīng)說明 本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系。bookmark41 假定與約束列出木軟件開發(fā)工作的假定與約束，例如經(jīng)費限制、開發(fā)期限等等。2.3功能需求bookmark41 功能劃分對于流程圖中的各個功能用樹狀結(jié)構(gòu)自頂向下進行細化。并對最底層的功能進行編 碼，給出功能標識符。 功能描述對最底層的功能所要完成的功能進行詳細描述，填入下表中:功能名稱功能標識符功能詳細描述2.4性能需求bookmark41 時間要求例如響應(yīng)時間、更新處理時間、數(shù)據(jù)轉(zhuǎn)換和傳送時間等等。bookmark41 適應(yīng)性（在操作方

7、式、運行環(huán)境、與其他軟件的接口等發(fā)生變化時，所具有的適應(yīng) 能力。）2.5運行環(huán)境描述bookmark41 硬件設(shè)備bookmark41 支持軟件（操作系統(tǒng)、數(shù)據(jù)庫、其他軟件系統(tǒng)如：lotus notes等）bookmark41 接口（硬件接口、軟件接口）bookmark41 控制（說明控制該軟件的運行的方法）bookmark41 用戶界面（反映業(yè)務(wù)流程的用戶界面）2.6其他需求bookmark41 如可用性、安全保密、可維護性、可跨平臺性等。（分高、中、低定性詳細描述）三軟件設(shè)計書（詳細設(shè)計說明書，建立軟件結(jié)構(gòu)）3.1引言bookmark41 編寫冃的軟件設(shè)計說明卩是為程序設(shè)計進行指導(dǎo)的文檔，

8、主耍功能是建立軟件的結(jié)構(gòu)，詳細 說明每個功能的上下功能模塊和輸入輸出接口。3.2硬件結(jié)構(gòu)設(shè)計bookmark41 描述碩件功能結(jié)構(gòu)圖3.3軟件結(jié)構(gòu)設(shè)計bookmark41 軟件功能結(jié)構(gòu)圖3.4數(shù)據(jù)結(jié)構(gòu)設(shè)計bookmark41 數(shù)據(jù)結(jié)構(gòu)（e-r圖）bookmark41 數(shù)據(jù)結(jié)構(gòu)為程序的關(guān)系用-張炬陣圖說明各個數(shù)據(jù)庫表與各模塊的對應(yīng)關(guān)系。模塊1模塊2數(shù)據(jù)庫表1七數(shù)據(jù)庫表n3.5硬件描述（逐個模塊給出以下的說明：）3.5.1模塊1 功能說明該程序應(yīng)具冇的功能，并填寫下表:系統(tǒng)：系統(tǒng)（項目）名稱設(shè)計人：xxx模塊:模塊名稱日期:20xx-xx-xx上層調(diào)用模塊可調(diào)用的下層模塊輸入輸出硬件模塊說明：局部

9、注釋項bookmark41 接口說明木程序所隸屬的上一層模塊及隸屬于木系統(tǒng)的下一層模塊。bookmark41 限制條件bookmark41 測試要點（給出測試模塊的主要測試要求。）bookmark41 尚未解決的問題3.5.2模塊2（內(nèi)容同上）3.5.3模塊n（內(nèi)容同上）3.6程序描述（逐個模塊給出以下的說明：）3.6.1模塊1 功能說明該程序應(yīng)貝有的功能，并填寫下表:系統(tǒng)：系統(tǒng)（項目）名稱設(shè)計人：xxx模塊:模塊名稱日期:20xx-xx-xx上層調(diào)用模塊可調(diào)用的下層模塊輸入輸出處理過程說明：局部注釋項bookmark41 算法本程序所選用的算法，具體的計算公式和計算步驟。bookmark41

10、 流程邏輯對當前模塊的實現(xiàn)用狀態(tài)圖來進行描述或者川流程圖的形式輔以必要的說明來表 示本程序的邏輯流程。bookmark41 接口說明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序，說明參數(shù) 賦值和調(diào)用方式，說明與木程序直接關(guān)聯(lián)的數(shù)據(jù)庫。bookmark41 限制條件bookmark41 測試耍點（給出測試模塊的主耍測試耍求。）bookmark41 尚未解決的問題3.6.2模塊2（內(nèi)容同上）3.6.3模塊n（內(nèi)容同上）四程序設(shè)計說明書4.1引言 編寫冃的說明本軟件的各功能模塊實現(xiàn)技巧及核心代碼4.2各功能核心代碼和界面說明4.2.1功能一實現(xiàn)技巧。 功能界血 核心代碼4.2.2功能二

11、實現(xiàn)技巧。 功能界面 核心代碼4.2.3功能n實現(xiàn)技巧。功能界面 核心代碼五軟件測試說明書5.1引言bookmark41 編寫冃的指導(dǎo)軟件測試并給出結(jié)果表以填寫測試結(jié)果5.2計劃bookmark41 測試方案（說明確定測試方法和選取測試用例的原則如：用八界而測試、功能流程 測試、性能測試。）bookmark41 測試項日（列出組裝測試和確認測試屮每一項測試的內(nèi)容、名稱、目的和進度。）bookmark41 測試準備bookmark41 測試機構(gòu)及人員（測試機構(gòu)名稱、負責(zé)人和職責(zé)。）5.3測試項目說明（按順序逐個對測試項冃做出說明：）bookmark41 測試項日名稱及測試內(nèi)容bookmark41

12、 測試用例輸入（輸入的數(shù)據(jù)和輸入命令。）輸出（預(yù)期的輸出數(shù)據(jù)。）步驟及操作bookmark41 進度bookmark41 條件（給出項測試対資源的特殊要求，如設(shè)備、軟件、人員等。）bookmark41 測試資料（說明項測試所需的資料。）5.4測試計劃執(zhí)行情況bookmark41 測試項目（用表格的形式列出每一測試項目的名稱、內(nèi)容和目的。）bookmark41 測試機構(gòu)和人員（給出測試機構(gòu)名稱、負責(zé)人和參與測試人員名單。）bookmark41 測試結(jié)果（按順序給出每一測試項冃的：a.實測結(jié)果數(shù)據(jù)；c.該項測試表明的事實; d.該項測試發(fā)現(xiàn)的問題。）5.5評價bookmark41 軟件能力（經(jīng)過測

13、試所表明的軟件能力o ）bookmark41 建議（提出為彌補上述缺陷的建議。）bookmark41 缺陷和限制（說明測試所揭露的軟件缺陷和不足，以及可能給軟件運行帶來的影 響。）bookmark41 測試結(jié)論（說明能否通過。）六用戶手冊6.1引言bookmark41 編寫冃的本手冊主耍用來指導(dǎo)用戶正確使用軟件并解決常見問題，使用對彖為本軟件的最終 使用者6.2系統(tǒng)功能介紹按照軟件使用者的一般工作分工說明軟件所具有的功能、這些功能幫助使用者解決實際 工作中的哪些問題、使用軟件后的優(yōu)點。6.3運行環(huán)境說明簡單說明運行本軟件所要求的：bookmark41 硬件設(shè)備環(huán)境，例如使用什么型號的計算機、配

14、備多少內(nèi)存及硬盤等；bookmark41 系統(tǒng)軟件的環(huán)境，例如windows> sql*net等；bookmark41 應(yīng)用軟件環(huán)境，例如運行木軟件時需要在系統(tǒng)中有哪些其他子系統(tǒng)的支持等。必要時可以說明軟件運行的基本環(huán)境和最佳環(huán)境。6.4運行前的準備說明這個軟件在運行前用戶應(yīng)該作的準備工作，如：代碼的編制、數(shù)據(jù)的準備、工作流 程的調(diào)整等等。在這里應(yīng)該列出所需要做的準備工作清單，以告訴用戶在使用前應(yīng)做好的準 備工作。有些系統(tǒng)初始化的工作，特別是需要系統(tǒng)維護人員操作的安裝和初始化工作操作方 法可在后血附錄的安裝與初始化中描述，在這里不必詳細說明。6.5輸入輸出說明和操作說陰這一部分是用戶手冊

15、的核心，這部分內(nèi)容應(yīng)該按照工作的流程順序來編寫。對于每個相對獨立運行的了系統(tǒng)或程序模塊，應(yīng)說明軟件的進入和退出方法。（在 windows環(huán)境下的軟件只盂說明快捷方式啟動軟件的方法即可，通常情況下不必再說明 用命令啟動軟件的方法。）在編寫操作說明時為了用戶使用的方便，應(yīng)該針対每一個工作流程編寫相應(yīng)的軟件操作 步驟和方法，具內(nèi)容應(yīng)該包括：bookmark41 功能簡介。bookmark41 工作流程中相應(yīng)軟件模塊的進入與退出方法。bookmark41 以醒口的方式列出常規(guī)工作吋操作步驟，詳細說明每個步驟中的屏幕和便用方法bookmark41 這一部分應(yīng)該盡屋讓軟件的使用操作人員對整個操作過程冇一個

16、明確的概念，在文 件編排上應(yīng)該把使用者的注意力集中在使用軟件解決他工作屮的問題上。bookmark41 対向計算機輸入的數(shù)據(jù)和計算機輸出的內(nèi)容給予適當?shù)恼f明。在語言上應(yīng)該使用易于用戶理解的詞匯而盡量不耍用計算機專業(yè)術(shù)語。6.6安全與保密說明軟件對保密管理的要求及違反保密規(guī)定后可能造成的后來。在一些子系統(tǒng)中，保密 字亂用后，可能造成個人工作量統(tǒng)計錯誤等等。6.7常見問題的處理根據(jù)需要說明在使用中可能遇到的問題及其解決方法。這些問題往往是山于在使用過程 屮的錯謀操作造成的。對于一些能夠預(yù)見的，經(jīng)常町能遇到的問題應(yīng)該在川戶手冊小提供解 決的方法，這樣能夠減少很多為用戶提供使用咨詢的工作罐。6.8附錄：安裝與初始化（必須提供）bookmark41 安裝列出軟件安裝的步驟，說明安裝過程屮的每一步操作方法