軟件文檔寫作實訓 (5)

1、遼 寧 工 業(yè) 大 學 實訓報告 題目:兼職中介管理系統(tǒng)軟件文檔院(系 :教師職稱:副教授 目 錄第 1章 實訓目的與要求 . . 1 1.1 實訓目的 . . 1 1.2 實訓的實驗環(huán)境 . . 1 1.3 實訓的預備知識 . . 1 1.4 實訓要求 . . 1第 2章 軟件文檔及其組成 . . 2 2.1軟件文檔的作用及分類 . 2 2.2軟件文檔所采用的標準 . 4 2.3 軟件文檔的主要內(nèi)容 . . 4第 3章 實 例 . . 6 3.1兼職中介管理系統(tǒng)軟件需求說明書實例 . 6 3.2 兼職中介管理系統(tǒng)數(shù)據(jù)庫設計實例 . . 8第 4章 實訓日記 . . 12第 5章 實訓總結(jié) .

2、 . 13參考文獻 . . 14第 1章 實訓目的與要求1.1 實訓目的本實訓要求學生通過具體的實例,模仿軟件開發(fā)過程中軟件文檔寫作的具體方法和 步驟,分組完成一套較為簡單軟件文檔,具體要達到以下幾點目的。1、了解 軟件開發(fā)周期各階段的文檔 。2、掌握各文檔闡述的內(nèi)容及作用。3、了解 文檔所采用的國際、國家等相關標準。4、了解各文檔所涉及的軟件知識。5、掌握各文檔采用的描述工具。6、具體編寫出 2個主要的軟件文件。1.2 實訓的實驗環(huán)境學校圖書館,互聯(lián)網(wǎng)查詢環(huán)境,具有軟件圖表制作軟件的計算機。1.3 實訓的預備知識要求學生修完全部專科所有課程, 具有較全面計算機軟件知識和一定的文獻檢索 能力及

3、動手實踐能力。該實訓應安排在畢業(yè)設計之前進行。1.4 實訓要求實訓過程中,要嚴格遵守實訓的時間安排,聽從指導教師的指導。正確地完成 上述內(nèi)容,記錄實習日記,規(guī)范完整地撰寫出實訓報告。第 2章 軟件文檔及其組成軟件文檔可以分為開發(fā)文檔和產(chǎn)品文檔兩大類。開發(fā)文檔包括:功能要求 、 投標方案 、 需求分析 、 技術(shù)分析 、 系統(tǒng)分 析 、 數(shù)據(jù)庫文檔 、 功能函數(shù)文檔 、 界面文檔 、 編譯手冊 、 QA 文檔 、 項目 總結(jié)等。產(chǎn)品文檔包括:產(chǎn)品簡介 、 產(chǎn)品演示 、 疑問解答 、 功能介紹 、 技術(shù)白皮 書 、 評測報告 、 安裝手冊 、 使用手冊 、 維護手冊 、 用戶報告 、 銷售培訓 等。

4、一、開發(fā)文檔:1. 功能要求 -來源于客戶要求和市場調(diào)查,是軟件開發(fā)中最早期的一個環(huán)節(jié)。 客戶提出一個模糊的功能概念,或者要求解決一個實際問題,或者參照同類軟件的一個 功能。有軟件經(jīng)驗的客戶還會提供比較詳細的技術(shù)規(guī)范書,把他們的要求全部列表書寫 在文檔中,必要時加以圖表解說。這份文檔是需求分析的基礎。2. 投標方案 -根據(jù)用戶的功能要求,經(jīng)過與招標方溝通和確認。3. 需求分析 -包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說、注意事 項、系統(tǒng)環(huán)境等。4. 技術(shù)分析 -包括技術(shù)選型、技術(shù)比較、開發(fā)人員、關鍵技術(shù)問題的解決、技 術(shù)風險、技術(shù)升級方向、技術(shù)方案評價,競爭對手技術(shù)分析等。以需求分析為

5、基礎, 進行詳細的技術(shù)分析, 列出本項目需要使用什么技術(shù)方案, 有哪些技術(shù)問題要解決 , 估 計開發(fā)期間會碰到什么困難,技術(shù)方案以后如何升級,對本項目的技術(shù)有什么評價等。 5. 系統(tǒng)分析 -包括功能實現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、數(shù)據(jù)字典、 軟件開發(fā)需要考慮的各種問題等。 以 需求分析 為基礎, 進行詳細的系統(tǒng)分析 (產(chǎn)品的 開發(fā)和實現(xiàn)方法 ,估計開發(fā)期間需要把什么問題說明白,程序員根據(jù)系統(tǒng)分析 ,開 始在項目主管的帶領下進行編碼。6. 數(shù)據(jù)庫文檔 -包括數(shù)據(jù)庫名稱、 表名、 字段名、 字段類型、 字段說明、 備注、 字段數(shù)值計算公式等。以系統(tǒng)分析為基礎,進行詳細的數(shù)據(jù)庫設計。必要時可以

6、用 圖表解說,特別是關系數(shù)據(jù)庫。7. 功能函數(shù)文檔 -包括變量名、變量初植、功能,函數(shù)名,參數(shù),如何調(diào)用、 備注、注意事項等。以系統(tǒng)分析為基礎,進行詳細的說明,列出哪個功能涉及多少 個函數(shù),以便以后程序員修改、接手和擴展。8. 界面文檔 -包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其 它界面部件的要求,這里與軟件完成后的運行界面是一致的。9. 編譯手冊 -包括服務器編譯環(huán)境、操作系統(tǒng)、編譯工具、 GNU 的 C+編譯器 版本信息、目錄說明、程序生成、源程序文件列表、 Makefile 配置及其相關程序的對應 關系列表。10. QA 文檔 -包括產(chǎn)品簡介、產(chǎn)品原理、產(chǎn)品功能列表、功能

7、描述、功能流程、 執(zhí)行結(jié)果、數(shù)據(jù)庫結(jié)構(gòu)、測試要求等,提供給軟件測試人員使用。11. 項目總結(jié) -包括項目簡介、項目參與人員和開發(fā)時間、項目風險管理過程、 項目功能列表、項目結(jié)構(gòu)特點、技術(shù)特點、對項目的升級建議、對以后的項目的建議、 人員素質(zhì)情況等。二、產(chǎn)品文檔:1. 產(chǎn)品簡介 -包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點、運 行要求和公司聯(lián)系地址。2. 產(chǎn)品演示 -包括公司簡介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點、產(chǎn)品作用、適 用范圍、 使用分析、 功能模塊、 解決問題、 合作伙伴、 成功案例等。 一般用 Power 、 point 或者 VCD 錄制軟件實現(xiàn)。3. 疑問解答 -列出用戶關

8、心的問題和處理方法。用于解答軟件的操作功能和解 決用戶的疑難問題。4. 功能介紹 -以需求分析為書寫基礎,包括軟件介紹、軟件結(jié)構(gòu)、功能列 表、功能描述和公司聯(lián)系地址。5. 技術(shù)白皮書 -以技術(shù)分析為書寫基礎,包括功能實現(xiàn)、技術(shù)選型、關鍵 技術(shù)問題的解決、技術(shù)方案特點、技術(shù)升級方向等。6. 評測報告 -第三方權(quán)威評測報告。包括評測目的、評測范圍、評測環(huán)境、評 測內(nèi)容、實測數(shù)據(jù)、性能表現(xiàn)、結(jié)果分析和評測總結(jié)等。7. 安裝手冊 -包括系統(tǒng)環(huán)境、運行平臺、產(chǎn)品安裝過程、初始環(huán)境設置、安裝 記錄等。8. 使用手冊 -包括產(chǎn)品簡介、功能列表、功能描述和解釋、功能操作、客戶服 務和聯(lián)系方式等。9. 維護手冊

9、 -包括產(chǎn)品簡介、系統(tǒng)須知、初始環(huán)境設置、系統(tǒng)配置、數(shù)據(jù)管理 和備份、技術(shù)問題解答和聯(lián)系方式等。10. 用戶報告 -包括產(chǎn)品簡介、購買時間、使用目的、使用時間、使用地點、 實施過程、出現(xiàn)問題和解決、產(chǎn)品總結(jié)和建議等。11. 銷售培訓 -包括項目簡介、產(chǎn)品功能、產(chǎn)品特點、商業(yè)優(yōu)勢、系統(tǒng)運行環(huán)境、適 用范圍、目標客戶等。軟件文檔的標準分為國標 8567-88和國標 8567-2006, 這連個標準分別是在 1988年 和 2006年實施的。一、標準編號 :GB/T 8567-1988標準名稱 :計算機軟件產(chǎn)品開發(fā)文件編制指南標準狀態(tài) :作廢英文標題 :Guidelines for computer

10、 software product development documentation 替代情況 :被 GB/T 8567-2006代替實施日期 :1988-7-1頒布部門 :國家標準局內(nèi)容簡介 :本指南是一份指導性文件。 本指南建議, 在一項計算機軟件的開發(fā)過程中, 一般地說,應該產(chǎn)生十四種文件。這十四種文件是:可行性研究報告;項目開發(fā)計劃; 軟件需求說明書;數(shù)據(jù)要求說明書;概要設計說明書;詳細設計說明書;數(shù)據(jù)庫設計說 明書;用戶手冊;操作手冊;模塊開發(fā)卷宗;測試計劃;測試分析報告;開發(fā)進度月報; 項目開發(fā)總結(jié)報告。二、標準編號 :GB/T 8567-2006標準名稱 :計算機軟件文檔編制規(guī)

11、范標準狀態(tài) :現(xiàn)行英文標題 :Specification for computer software documentation替代情況 :替代 GB/T 8567-1988實施日期 :2006-7-1頒布部門 :中華人民共和國國家質(zhì)量監(jiān)督檢驗檢疫總局 中國國家標準化管理委員會 內(nèi)容簡介 :本標準對軟件的開發(fā)過程和管理過程應編制的主要文檔及其編制的內(nèi)容、 格式規(guī)定了基本要求。 本標準原則上適用于所有類型的軟件產(chǎn)品的開發(fā)過程和管理過程。2.3 軟件文檔的主要內(nèi)容文檔編寫標準化,在整個項目開發(fā)及使用過程中,應該有完備的文檔支持,文檔編制 要求具有針對性、精確性、清晰性、完整性、靈活性和可追溯性。完

12、備的文檔對軟件的開發(fā)及使用起了很大的作用。一般要求編寫好十三種文檔。 1、可行性分析報告說明該軟件開發(fā)項目的實現(xiàn)在技術(shù)上、經(jīng)濟上和社會因素上的可行性,評述為了合理 地達到開發(fā)目標可供選擇的各種可能實施方案,說明并論證所選定實施方案的理由。2、項目開發(fā)計劃為軟件項目實施方案制訂出具體計劃, 應該包括各部分工作的負責人員、 開發(fā)的進度、 開發(fā)經(jīng)費的預算、所需的硬件及軟件資源等。3、軟件需求說明書(軟件規(guī)格說明書對所開發(fā)軟件的功能、性能、用戶界面及運行環(huán)境等作出詳細的說明。它是在用戶與 開發(fā)人員雙方對軟件需求取得共同理解并達成協(xié)議的條件下編寫的,也是實施開發(fā)工作的 基礎。該說明書應給出數(shù)據(jù)邏輯和數(shù)據(jù)

13、采集的各項要求,為生成和維護系統(tǒng)數(shù)據(jù)文件做好 準備。4、概要設計說明書是概要設計階段的工作總結(jié)。主要包括功能分配、模塊劃分、程序總體結(jié)構(gòu)、輸入輸 出以及接口設計、運行設計、數(shù)據(jù)結(jié)構(gòu)設計和出錯處理等,為詳細設計作好準備。5、詳細設計說明書著重描述每一模塊是怎樣實現(xiàn)的,包括實現(xiàn)算法、邏輯流程等。6、用戶操作手冊詳細描述了該軟件的功能、性能和用戶界面,使用該軟件的具體方法等。7、測試計劃包括測試內(nèi)容、進度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍 等。8、測試分析報告測試計劃的執(zhí)行情況,對測試結(jié)果的分析,提出測試結(jié)論。9、開發(fā)進度月報按月提交的項目進展情況報告。包括計劃與實際執(zhí)行情況的

14、對比、階段成果、遇到的 問題、解決的方法以及下一步的打算。10、項目開發(fā)總結(jié)報告項目完成以后,總結(jié)實際執(zhí)行情況。如進度、成果、資源利用、成本和投入的人力, 對項目開發(fā)作出評價,總結(jié)經(jīng)驗與教訓。11、軟件維護手冊主要包括軟件系統(tǒng)說明、 程序模塊說明、 操作環(huán)境、 支持軟件說明、 維護過程說明等。 12、軟件問題報告記錄軟件出現(xiàn)問題的日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等,為軟件修改提供準備文 檔。13、軟件修改報告軟件產(chǎn)品投入使用后,發(fā)現(xiàn)了需修改、更正的問題,要將出現(xiàn)的問題、修改意見、修改 可能出現(xiàn)影響作出詳細描述,提交審批。第 3章 實 例 3.1兼職中介管理系統(tǒng)軟件需求說明 書 實例 3.2 兼

15、職中介管理系統(tǒng)數(shù)據(jù)庫設計實例 第 4章 實訓日記第 1天:選擇題目。我選擇的題目是兼職中介管理系統(tǒng)。第 2-3天:去圖書館查閱了大量關于兼職中介管理系統(tǒng)軟件工程文檔的相關資料并 在網(wǎng)上查找了一些關于軟件工程設計的資料,要對每個細節(jié)要進行全面的設計和說明。 第 4-6天:整理從圖書館和網(wǎng)上收集來的資料和程序代碼,分析模塊功能,閱讀軟 件工程書籍, 對軟件工程文檔的撰寫有了一定了解, 了解對軟件工程文檔作用及分類并 對其中內(nèi)容整理到報告中,了解軟件工程文檔所采用的標準及分類并對內(nèi)容整理到報告 中,整理軟件工程文檔主要內(nèi)容到報告中,完成報告實例一,對其中遇到的問題記錄下 來,然后通過從網(wǎng)上查資料找答

16、案和大家共同研究探索解決,再完成實例一之后用同樣 的方式按部就班的進行著實例二的編寫,再完成實例二之后,通過 2周的實訓,完成實 訓總結(jié)內(nèi)容,總結(jié)這 2周的收獲。第 7天:完成兼職中介管理系統(tǒng)軟件工程文檔報告,上交作品。遼 寧 工 業(yè) 大 學 綜 合 實 訓 說 明 書（論 文） 第 5 章 實訓總結(jié) 兼職中介管理系統(tǒng)能夠使得管理者快速高效地完成企業(yè)日常事務中的人事工作，降 低了管理成本，使管理者能集中精力在企業(yè)戰(zhàn)略目標；另一方面，通過軟件及時收集與 整理分析大量的管理數(shù)據(jù)，為企業(yè)戰(zhàn)略決策的生成與實施控制提供強有力的支持，以提 高組織目標實現(xiàn)的可能性。人力資源管理系統(tǒng)的總目標是：在計算機網(wǎng)絡，

17、數(shù)據(jù)庫和先 進的開發(fā)平臺上，利用現(xiàn)有的軟件，配置一定的硬件，開發(fā)一個具有開放體系結(jié)構(gòu)的、 易擴充的、易維護的、具有良好人機交互界面的兼職中介管理系統(tǒng)，實現(xiàn)人員管理自動 化的計算機系統(tǒng)，為企業(yè)的決策層提供準確、精細、迅速的人事變動信息。 通過一周的實訓，使我對軟件工程文檔知識有了進一步的了解，這是一次全面綜合 的訓練。我們通過學習實用軟件工程這門課程，才可以成功的完成了這次課程設計， 在實驗過程中雖然遇到了很多問題，但是通過從圖書館里借來的資料和從網(wǎng)上查找的資 料都把問題一一地解決了。這次課程設計主要是讓我們加深對軟件工程文檔寫作基本知 識的理解，掌握并運用軟件工程文檔寫作來設計系統(tǒng)程序的基本方

18、法及基本技巧。這與 我們平時學的知識息息相關，也有利于我們很好地把學會的知識應用到實踐中去。 這次課程設計使我得到了充分的鍛煉，真是受益匪淺。從中也認識到了團隊的重要性。 雖然也遇到過很多困難，但通過我們這個小團隊的努力以及老師的幫助，都把困難一一 克服了。通過這學期的學習，使我又掌握了不少的新知識，使我對軟件工程這門課更加 感興趣，感謝老師及同學對我的幫助，我會更加努力的學習，來使自己的知識更加的豐 富。 13 遼 寧 工 業(yè) 大 學 綜 合 實 訓 說 明 書（論 文） 參考文獻 1 王新穎 2 鄭人杰 3 唐任仲 4 潘孝銘 5 肖 剛 6 劉 冰 7 徐世河 8 顧小航 9 趙池龍 10吳東強 11張應輝 12吳潔明 13候清富 14羅先文 15劉長青 軟件工程與文檔編寫 北京大學出版社 2007.6 實用軟件工程（第 4 版） 清華大學出版社 2003.4 工程應用軟件開發(fā)技術(shù) 化學工業(yè)出版社 1999.5 軟件文檔編