軟件工程軟件課程實踐文檔

1、 軟件課程實踐文檔（參考格式）項目名稱：項目完成人：學(xué)號：班號：學(xué)號：班號：學(xué)號：班號：項目完成日期：文檔編制說明：1. 本文檔模板適用于面向?qū)ο蠹夹g(shù)課程實踐。模板中用方括號括起來的藍(lán)色斜體文本是對指定文檔章節(jié)應(yīng)當(dāng)書寫容和方法的簡要提示，在提交的作業(yè)中應(yīng)該將其刪除。項目組應(yīng)當(dāng)參考本文檔模板撰寫文檔。此外，考慮到具體項目類型、規(guī)模，以及采用的開發(fā)過程和方法的差異，項目組可以對文檔容及其格式做適當(dāng)調(diào)整。對于所做的調(diào)整，應(yīng)當(dāng)在1.5節(jié)中加以說明。2. 容應(yīng)當(dāng)簡單明了、具體詳實，并且要“前后一致”，即設(shè)計與需求一致，實現(xiàn)與設(shè)計一致。特別是在開發(fā)原型系統(tǒng)時，應(yīng)當(dāng)明確說明對需求、設(shè)計和實現(xiàn)的簡化或裁減。提

2、交作業(yè)情況記錄提交次數(shù)提交日期提交容說明備注說明：在提交容說明一欄里，具體說明本次提交的作業(yè)中新增或變更的具體容，包括杰、段落、圖表，以及程序中的文件、類或函數(shù)等。1概述說明：本章應(yīng)提供整個文檔的概述。它應(yīng)包括本文檔的目的、圍、定義、首字母縮寫詞、縮略語、參考資料和概述。舉例：本文檔是本課程實踐項目項目名稱相關(guān)文檔的匯編，包括本項目的用戶需求規(guī)格說明、軟件開發(fā)計劃、軟件概要設(shè)計說明、軟件詳細(xì)設(shè)計說明、軟件實現(xiàn)與測試說明、軟件安裝與使用說明，以及課程實踐總結(jié)。1.1目的說明：闡明本文檔的目的。舉例：本文檔旨在根據(jù)對用戶需求的分析和論證，編制書面的文檔。本文檔是本項目開發(fā)的重要依據(jù)和主要成果，它與

3、軟件程序一起構(gòu)成本項目的最終軟件產(chǎn)品。1.2圍說明：簡要說明本文檔的圍。舉例：本文檔包括本項目的用戶需求規(guī)格說明、軟件開發(fā)計劃、軟件概要設(shè)計說明、軟件詳細(xì)設(shè)計說明、軟件實現(xiàn)與測試說明、軟件安裝與使用說明，以及課程實踐總結(jié)。1. 3術(shù)語和縮略語定義說明：本節(jié)應(yīng)提供正確理解本文檔所需的重要術(shù)語的定義、首字母縮寫詞和縮略語。 這些信息可以通過建立項目詞匯表來提供。建議格式如下：中文術(shù)語或縮略語（英文對應(yīng)詞）： 術(shù)語解釋，說明出處、含義等舉例：對于學(xué)生注冊系統(tǒng)SRS，學(xué)生注冊（Student Registration）：指學(xué)生在一個學(xué)期初的指定時間在學(xué)生注冊系統(tǒng)中選擇并最終確定本學(xué)期選修課程

4、的過程。1.4 參考資料說明：本節(jié)應(yīng)完整列出本文檔中其他部分所引用的任何標(biāo)準(zhǔn)、規(guī)、參考文獻(xiàn)和文檔等資料。每個文檔應(yīng)標(biāo)有標(biāo)題、報告號（如果適用）、日期和出版單位。列出可獲取這些參考資料的來源。建議格式如下：標(biāo)識符或編號 作者，文獻(xiàn)名稱，名稱（或歸屬單位），日期標(biāo)識符或編號 作者，文章名，期刊名稱或會議名稱，日期，刊號（期號）：首頁：尾頁舉例：1 柯等譯，Java面向?qū)ο缶幊讨改希˙eginning Java Objects） ， 美Jacquie Barker, 電子工業(yè)，2001.112 超，學(xué)生注冊系統(tǒng)（Student Registration System）需求說明（面向?qū)ο蠹夹g(shù)課程實踐）

5、，航空航天大學(xué)軟件工程研究所，2003.9，393 超，軟件課程實踐文檔（面向?qū)ο蠹夹g(shù)課程實踐），航空航天大學(xué)軟件工程研究所，2004.2，391.5 簡述說明：本節(jié)應(yīng)說明本文檔中其他部分所包含的容，并解釋文檔的組織方式。舉例：本文檔包括本項目的用戶需求規(guī)格說明、軟件開發(fā)計劃、軟件概要設(shè)計說明、軟件詳細(xì)設(shè)計說明、軟件實現(xiàn)與測試說明、軟件安裝與使用說明，以及課程實踐總結(jié)等容。第二章是用戶需求規(guī)格說明，具體說明用戶的基本需求，并給出本軟件的用例模型和相關(guān)說明。2 用戶需求規(guī)格說明2.1概述 說明：本章應(yīng)當(dāng)從用戶的角度，用通俗易懂和準(zhǔn)確

6、的語言具體說明本軟件產(chǎn)品是什么，用于什么目的，以及相關(guān)的產(chǎn)品開發(fā)背景，比如當(dāng)前的工作方式，所使用的產(chǎn)品情況等。2.2產(chǎn)品面向的用戶群體說明：本章應(yīng)當(dāng)從用戶的角度，用通俗易懂和準(zhǔn)確的語言具體說明本產(chǎn)品面向的用戶（客戶、最終用戶）的特征。2.3 產(chǎn)品的業(yè)務(wù)需求說明：本章應(yīng)當(dāng)從用戶的角度，用通俗易懂和準(zhǔn)確的語言具體說明：（1）本產(chǎn)品面向的業(yè)務(wù)領(lǐng)域及其特征。（2）本產(chǎn)品必須支持的業(yè)務(wù)活動及其必須遵循的操作規(guī)程、業(yè)務(wù)活動的參與者（人員或外部系統(tǒng)）、各項業(yè)務(wù)活動必須的輸入和產(chǎn)生的輸出，以及必需的資源等。舉例：建立用例模型，并詳細(xì)說明各個用例和相關(guān)容；類圖模型，描述領(lǐng)域/業(yè)務(wù)概念模型；順序圖，描述與用例相對

7、應(yīng)的各種場景；活地圖，描述業(yè)務(wù)流程；狀態(tài)圖，描述對象類的狀態(tài)等2.4產(chǎn)品應(yīng)當(dāng)遵循的標(biāo)準(zhǔn)或規(guī)說明：本章應(yīng)當(dāng)從用戶的角度，具體說明：本產(chǎn)品應(yīng)當(dāng)遵循哪些標(biāo)準(zhǔn)、規(guī)或業(yè)務(wù)規(guī)則。舉例：對于學(xué)生注冊系統(tǒng)SRS，應(yīng)當(dāng)符合學(xué)校有關(guān)學(xué)生注冊的規(guī)定。2.5產(chǎn)品的功能性需求 說明：本章應(yīng)當(dāng)從用戶的角度，具體說明：(1)產(chǎn)品的功能性需求;(2)產(chǎn)品功能性需求的細(xì)化和分解。下表中的功能1、功能1.1等符號應(yīng)當(dāng)被替換成有含義的名稱。表2.5 功能性需求分類功 能 類 別子 功 能說明功能域1功能1.1功能1.22.6用戶界面需求說明：本章應(yīng)當(dāng)從用戶的角度，具體說明：有關(guān)用戶界面設(shè)計和實現(xiàn)方面的要求，以及與其它功能的關(guān)系等。

8、2.7 軟硬件環(huán)境需求說明：本章應(yīng)當(dāng)從用戶的角度，具體說明：運(yùn)行和使用本軟件產(chǎn)品所需的軟硬件，和對軟硬件環(huán)境方面的要求等。2.8 產(chǎn)品質(zhì)量需求說明：本章應(yīng)當(dāng)從用戶的角度，具體說明：有關(guān)產(chǎn)品質(zhì)量方面的要求等。舉例：在功能性、可靠性、易用性、安全性、性能等方面的具體要求。2.9 其他需求和約束說明：本章應(yīng)當(dāng)從用戶的角度，具體說明：其它方面的要求等。舉例：對課程實踐完成時間的要求等。3 軟件開發(fā)計劃3.1 項目目標(biāo)和制約條件說明：本項目預(yù)期的目標(biāo)和制約條件。舉例：本項目計劃是設(shè)計并實現(xiàn)本軟件的一個原型，包括等需求。影響本項目的主要約束有。3.2任務(wù)分工和進(jìn)度計劃說明：定義項目過程，分解和細(xì)化項目開發(fā)

9、工作，具體分配每個成員的任務(wù)，并制定進(jìn)度計劃。應(yīng)當(dāng)制作進(jìn)度表，并建議采用Microsoft Project等工具制作Gantt 圖。表3.1 過程定義簡表活動名稱任務(wù)名稱及說明（文檔章節(jié)和模型圖、程序代碼、測試用例等）負(fù)責(zé)人起止時間工作量估計（頁數(shù)/小時數(shù)）軟件需求分析軟件項目計劃軟件概要設(shè)計軟件詳細(xì)設(shè)計編碼與單元測試集成測試使用說明4 軟件概要設(shè)計 說明:給出軟件的該設(shè)計，包括軟件的邏輯模型，包括數(shù)據(jù)模型、行為模型等，以及用戶界面等方面的設(shè)計。4.1邏輯模型說明：采用邏輯模型描述軟件系統(tǒng)的結(jié)構(gòu)特征和行為能力，重點(diǎn)是采用類圖描述系統(tǒng)中的基本概念和組成成分，及其相互關(guān)系，采用狀態(tài)圖、活動圖等描述

10、系統(tǒng)的行為，以及其部對象的操作過程。舉例：根據(jù)用例模型，建立軟件的邏輯模型，并給出相關(guān)容的具體說明，建立各個模型的數(shù)據(jù)詞典。4.1-1 模型簡表模型代碼模型（中文）名稱模型（英文）名稱說明4.1-某 某模型元素簡表模型元素代碼模型元素（中文）名稱模型元素（英文）名稱元素類型說明4.2 用戶界面設(shè)計說明：用戶界面的總體設(shè)計方案。舉例：有關(guān)窗口、選單、結(jié)果視圖等的設(shè)計。4.3 其他說明說明：其它設(shè)計說明。舉例：對于分布式軟件，采用部署模型描述其物理實現(xiàn)方案。5軟件詳細(xì)設(shè)計說明：進(jìn)一步細(xì)化概要設(shè)計方案，重點(diǎn)是(1)完成類圖模型的細(xì)化工作，針對具體實現(xiàn)方法，增添必要的類、屬性或操作，并進(jìn)行必要的優(yōu)化。

11、(2)采用構(gòu)件模型或者列表的方法，說明邏輯模型與物理實現(xiàn)的對應(yīng)關(guān)系。6 軟件編碼與單元測試說明：（1）對代碼的編寫風(fēng)格，程序的組織等的具體說明。（2）對于每一個單元的測試用立集合。7 軟件集成測試說明：軟件集成的測試用例集合及對測試結(jié)果的說明。8 軟件使用說明說明：對軟件安裝和使用方法的說明。8.1 軟件概述說明：對軟件主要用途和使用方法的概要說明。8.2 軟件安裝說明：對軟件主要用途和使用方法的概要說明。8.3 軟件使用說明：對軟件啟動、各項功能（選單和命令）、數(shù)據(jù)格式等的說明。9 總結(jié)說明：簡要總結(jié)進(jìn)行課程實踐的經(jīng)驗和體會，對實踐過程中取得的成功經(jīng)驗、出現(xiàn)的問題進(jìn)行分析。附件1 項目組分工及實際完成情況說明任務(wù)編號任務(wù)名稱容說明（文檔章節(jié)和模型圖、程序代碼、測試用例等）