遼寧工業大學
軟體文件寫作實訓報告
題目： 班級管理系統軟體文件
院（系）: 軟體學院
專業班級：
指導教師
教師職稱： 副教授
起止時間： 2012.11.26-2012.12.02
實訓任務及評語
院（系）：軟體學院教研室：軟體教研室
目錄第1章實訓目的與要求 1
1.1 實訓目的 1
1.2 實訓的實驗環境 1
1.3 實訓的預備知識 1
1.4 實訓要求 1
第2章軟體文件及其組成 2
2.1軟體文件的作用及分類 2
2.2軟體文件所採用的標準 3
2.3 軟體文件的主要內容 4
第3章例項 5
3.1班級管理系統測試設計說明書例項 5
3.2班級管理系統使用者手冊例項 10
第4章實訓日記 13
第5章實訓總結 14
參考文獻 15
本實訓要求學生通過具體的例項，模仿軟體開發過程中軟體文件寫作的具體方法和步驟，分組完成一套較為簡單軟體文件，具體要達到以下幾點目的。
1、了解軟體開發周期各階段的文件。
2、掌握各文件闡述的內容及作用。
3、了解文件所採用的國際、國家等相關標準。
4、了解各文件所涉及的軟體知識。
5、掌握各文件採用的描述工具。
6、具體編寫出2個主要的軟體檔案。
學校圖書館，網際網路查詢環境，具有軟體圖表製作軟體的計算機。
要求學生修完全部專科所有課程，具有較全面計算機軟體知識和一定的文獻檢索能力及動手實踐能力。該實訓應安排在畢業設計之前進行。
實訓過程中，要嚴格遵守實訓的時間安排，聽從指導教師的指導。正確地完成上述內容，記錄實習日記，規範完整地撰寫出實訓報告。
一、軟體文件的定義
通過網上查閱，我知道了軟體文件的定義。軟體文件(document)也稱檔案,通常指的是一些記錄的資料和資料**，它具有固定不變的形式，可被人和計算機閱讀。它和電腦程式共同構成了能完成特定功能的計算機軟體(有人把源程式也當作文件的一部分)。
我們知道,硬體產品和產品資料在整個生產過程中都是有形可見的,軟體生產則有很大不同文件本身就是軟體產品。沒有文件的軟體,不成其為軟體,更談不到軟體產品。軟體文件的編制(documentation)在軟體開發工作中占有突出的地位和相當的工作量。
高效率,高質量地開發,分發,管理和維護文件對於轉讓,變更,修正,擴充和使用文件,對於充分發揮軟體產品的效益有著重要意義。
二、軟體文件的分類
軟體文件分類：基於軟體生存期方法，可以從形式上將軟體文件大致分為兩類：軟體開發過程中需要填寫的各種圖表，及應編制的各種技術檔案或管理資料。
而根據其產生和使用的範圍，主要劃分為三大類：開發文件、使用者文件和管理文件。
三、軟體文件的作用
1、開發文件作用:一作為軟體生存期夾斷之間的通訊工具，記錄生成軟體需求、設計、編碼、測試等的詳細規定和說明。二描述開發小組的工作職責。
通過規定軟體規劃設計主題指令碼編制、文件編制、質量保證等人員的角色，來定義「如何做」和「何時做」。三用作檢驗點，而允許管理者評估開發進度。如果開發文件缺失或過時，管理者將失去跟蹤和控制軟體專案的重要工具。
四形成系統維護人員所需求的基本的軟體支援文件，並構成產品文件的一部分。五記錄軟體開發的歷史。
2、使用者文件作用：一為使用和執行軟體產品的使用者提供培訓和執行參考資訊。二為產品維護工程師提供必要的資訊。三促進和方便軟體產品的市場推廣。
3、管理文件作用：主要是對軟體開發過程的管理資訊進行描述。
標準編號:gb/t 8567-2006
標準名稱:計算機軟體文件編制規範
標準狀態:現行
英文標題:specification for computer software documentation
替代情況:替代gb/t 8567-1988
實施日期:2006-7-01
頒布部門:中華人民共和國國家質量監督檢驗檢疫總局，中國國家標準化管理委員會
內容簡介:本標準對軟體的開發過程和管理過程應編制的主要文件及其編制的內容、格式規定了基本要求。本標準原則上適用於所有型別的軟體產品的開發過程和管理過程。
除了國際標準，還可以參照其它工程領域對工程標準劃分的方法，軟體工程標準主要有兩種劃分方法：按標準的型別劃分和按標準的範圍劃分。
1、按標準的型別劃分：按標準的型別劃分主要有過程標準、產品標準、行業標準、記法標準等。過程標準與開發乙個產品或從事一項服務的一系列活動或操作有關。
過程標準使用一組方法、工具和技術，給出「誰來做」、「做什麼」、「如何做」、「何時做」、「何地做」及在軟體工程活動中進行的不同層次工作的過程模型。產品標準則涉及軟體工程事務的格式和內容。軟體開發和維護活動文件化的結果就是軟體產品，軟體文件是軟體工程活動進一步開展的基礎。
軟體開發作為一種行業，其行業標準涉及軟體工程的所有方面，如職業認證、職業培訓、產品許可等。行業標準可以等同於行業行為規範。記法標準規定了在軟體工程行業範圍內，以唯一的方式進行交流的方法，如術語、表示法、語言等。
它其實是一種語境規範。
2、按標準的範圍劃分：按標準的範圍劃分主要是根據軟體的任務功能和軟體生存期進行比較、判定、評價和確定軟體工程標準的範圍和內容。任務功能可以表示軟體工程過程，可以劃分為產品工程功能、驗證與確認功能以及技術管理功能3個部分。
產品工程功能包括定義、生產和支援最終產品所必須的過程。驗證和確認功能是檢查產品質量的活動。技術管理功能是構造和控制產品工程的過程。
這3個部分並不集中在單個的軟體生存週期裡，而是並行進行的生產、檢查和控制活動。
在專案開發過程中，應該要去編寫好十三種文件，文件編制要求具有針對性、精確性、清晰性、完整性、靈活性和可追溯性。完備的文件對軟體的開發及使用起了很大的作用。
1、可行性研究報告：說明該軟體開發專案的實現在技術上,經濟上和社會因素上的可行性,評述為了合理地達到開發目標可供選擇的各種可能實施的方案,說明並論證所選定實施方案的理由。
2、 專案開發計畫：為軟體專案實施方案制定出具體計畫,應該包括各部分工作的負責人員,開發的進度,開發經費的預算,所需的硬體及軟體資源等。
3、軟體需求說明書:也稱軟體規格說明書,其中對所開發軟體的功能,效能,使用者介面及執行環境等作出詳細的說明。它是使用者與開發人員雙方對軟體需求取得共同理解基礎上達成的協議, 也是實施開發工作的基礎。
4、概要設計說明書:該說明書是概要設計階段的工作成果,它應說明功能分配,模組劃分,程式的總體結構,輸入輸出以及介面設計,執行設計,資料結構設計和出錯處理設計等,為詳細設計奠定基礎。
5、詳細設計說明書:著重描述每一模組是怎樣實現的, 包括實現演算法,邏輯流程等。
6、使用者操作手冊:本手冊詳細描述軟體的功能,效能和使用者介面,使使用者了解如何使用該軟體。
7、測試計畫:為做好組裝測試和確認測試,需為如何組織測試制定實施計畫。計畫應包括測試的內容,進度,條件,人員,測試用例的選取原則,測試結果允許的偏差範圍等。
8、測試分析報告:測試工作完成以後,應提交測試計畫執**況的說明。對測試結果加以分析,並提出測試的結論意見。
9、開發進度月報:該月報系軟體人員按月向管理部門提交的專案進展情況報告。報告應包括進度計畫與實際執**況的比較, 階段成果,遇到的問題和解決的辦法以及下個月的打算等。
10、專案開發總結報告:軟體專案開發完成以後,應與專案實施計畫對照,總結實際執行的情況,如進度,成果,資源利用,成本和投入的人力。此外還需對開發工作作出評價,總結出經驗和教訓。
11、軟體維護手冊：主要包括軟體系統說明、程式模組說明、操作環境、支援軟體的說明、維護過程的說明，便於軟體的維護。
12、軟體問題報告：指出軟體問題的登記情況，為軟體修改提供準備文件。
13、軟體修改報告：軟體產品投入執行以後，發現了需對其進行修正、更改等問題，應將存在的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。
軟體寫作實訓報告
遼寧工業大學 題目 超市管理系統軟體文件 院 系軟體學院 專業班級 計算機網路技術082班 學號 081406026 學生姓名 蔣琪鑫 指導教師 丁寶柱 教師職稱 助教 起止時間 2010.11.22 2010.12.05 實訓任務及評語 院 系 軟體學院教研室 軟體教研室 目錄第1章實訓目的與要求...
網管081軟體寫作實訓報告
遼寧工業大學 軟體文件寫作實訓報告 題目 學生管理系統軟體文件 院 系 軟體學院 專業班級 網路系統管理081班 學號學生姓名 指導教師 田蕊 教師職稱 助教 起止時間 2010.11.22 2010.12.05實訓任務及評語 院 系 軟體學院教研室 軟體教研室 目錄第1章實訓目的與要求 1 1.1...
學生管理系統軟體軟體寫作實訓報告
遼寧工業大學 軟體文件寫作實訓報告 題目 學生管理系統軟體文件 院 系 軟體學院 專業班級 學號學生姓名 指導教師 丁寶柱 教師職稱 起止時間 2012.12.03 2012.12.09 實訓任務及評語 院 系 軟體學院教研室 軟體教研室 目錄第1章實訓目的與要求 1 1.1 實訓目的 1 1.2 ...