遼寧工業大學
軟體文件寫作實訓報告
題目： 班級管理系統軟體文件
院（系）: 軟體學院
專業班級： 軟體工程113班
學號： 111301066
學生姓名： 安凱辰
指導教師： 翟寶峰
教師職稱： 副教授
起止時間： 2012.12.5-2012.12.11
實訓任務及評語
院（系教研室：軟體教研室
目錄第1章實訓目的與要求 1
1.1 實訓目的 1
1.2 實訓的實驗環境 1
1.3 實訓的預備知識 1
1.4 實訓要求 1
第2章軟體文件及其組成 2
2.1軟體文件的作用及分類 2
2.2軟體文件所採用的標準 2
2.3 軟體文件的主要內容 3
第3章例項 5
3.1 班級管理系統詳細設計說明書例項 5
3.2 班級管理系統測試分析報告例項 9
第4章實訓日記 13
第5章實訓總結 14
參考文獻 15
本實訓要求學生通過具體的例項，模仿軟體開發過程中軟體文件寫作的具體方法和步驟，分組完成一套較為簡單軟體文件，具體要達到以下幾點目的。
1、了解軟體開發周期各階段的文件。
2、掌握各文件闡述的內容及作用。
3、了解文件所採用的國際、國家等相關標準。
4、了解各文件所涉及的軟體知識。
5、掌握各文件採用的描述工具。
6、具體編寫出2個主要的軟體檔案。
學校圖書館，網際網路查詢環境，具有軟體圖表製作軟體的計算機。
要求學生修完全部專科所有課程，具有較全面計算機軟體知識和一定的文獻檢索能力及動手實踐能力。該實訓應安排在畢業設計之前進行。
實訓過程中，要嚴格遵守實訓的時間安排，聽從指導教師的指導。正確地完成上述內容，記錄實習日記，規範完整地撰寫出實訓報告。
軟體文件的作用：
在軟體的生產過程中，總是伴隨著大量的資訊要記錄、要使用。因此，軟體文件在產品的開發生產過程中起著重要的作用。
1)提高軟體開發過程的能見度。把開發過程中發生的事件以某種可閱讀的形式記錄在文件中。管理人員可把這些記載下來的材料作為檢查軟體開發進度和開發質量的依據，實現對軟體開發的工程管理。
2)提高開發效率。軟體文件的編制，使得開發人員對各個階段的工作都進行周密思考、全盤權衡、從而減少返工。並且可在開發早期發現錯誤和不一致性，便於及時糾正。
3)作為開發人員在一定階段的工作成果和結束標誌。
4)記錄開發過程中的有關資訊，便於協調以後的軟體、開發、使用和維護。
5)提供對軟體的執行、維護和培訓的有關資訊，便於管理人員、開發人員、操作人員、使用者之間的協作、交流和了解。使軟體開發活動更科學、更有成效。
6)便於潛在使用者了解軟體的功能、效能等各項指標，為他們選購符合自己需要的軟體提供依據。
文件在各類人員、計算機之間的多種橋梁作用中看出：
既然軟體已經從手工藝人的開發方式發展到工業化的生產方式，文件在開發過程中就起到關鍵作用。從某種意義上來說，文件是軟體開發規範的體現和指南。按規範要求生成一整套文件的過程，就是按照軟體開發規範完成乙個軟體開發的過程。
所以，在使用工程化的原理和方法來指導軟體的開發和維護時，應當充分注意軟體文件的編制和管理
軟體文件的分類：
軟體文件從形式上來看，大致可分為兩類：
一類是開發過程中填寫的各種圖表，可稱之為工作**；另一類是應編制的技術資料或技術管理資料，可稱之為文件或檔案。
軟體文件的編制，可以用自然語言，特別設計的形式語言，介於兩者之間的半形式語言(結構化語言)，各類圖形表示。**來編制文件。文件可以書寫，也可以在計算機支援系統中產生，但它必須是可閱讀的。
按照文件產生和使用的範圍，軟體文件大致可分為三類：
1)開發文件：這類文件是在軟體開發過程中，作為軟體開發人員前一階段工作成果的體現和後一階段工作依據的文件。包括軟體需求說明書、資料要求說明書、概要設計說明書、詳細設計說明書、可行性研究報告、專案開發計畫。
2)管理文件：這類文件是在軟體開發過程中，由軟體開發人員制定的需提交人員的一砦工作計畫或工作報告。使管理人員能夠通過這些文件了解軟體開發專案安排、進度、資源使用和成果等。
包括專案開發計畫、測試計畫、測試報告、開發進度月報及專案開發總結。
3)使用者文件：這類文件是軟體開發人員為使用者準備的有關該軟體使用、操作、維護的資料。包括使用者手冊、操作手冊、維護修改建議、軟體需求說明書。
2.2軟體文件所採用的標準
一、按標準的型別劃分：
按標準的型別劃分主要有過程標準、產品標準、行業標準、記法標準等。過程標準與開發乙個產品或從事一項服務的一系列活動或操作有關。過程標準使用一組方法、工具和技術，給出「誰來做」、「做什麼」、「如何做」、「何時做」、「何地做」及在軟體工程活動中進行的不同層次工作的過程模型。
產品標準則涉及軟體工程事務的格式和內容。軟體開發和維護活動文件化的結果就是軟體產品，軟體文件是軟體工程活動進一步開展的基礎。軟體開發作為一種行業，其行業標準涉及軟體工程的所有方面，如職業認證、職業培訓、產品許可等。
行業標準可以等同於行業行為規範。記法標準規定了在軟體工程行業範圍內，以唯一的方式進行交流的方法，如術語、表示法、語言等。它其實是一種語境規範。
二、按標準的範圍劃分：
按標準的範圍劃分主要是根據軟體的任務功能和軟體生存期進行比較、判定、評價和確定軟體工程標準的範圍和內容。任務功能可以表示軟體工程過程，可以劃分為產品工程功能、驗證與確認功能以及技術管理功能3個部分。產品工程功能包括定義、生產和支援最終產品所必須的過程。
驗證和確認功能是檢查產品質量的活動。技術管理功能是構造和控制產品工程的過程。這3個部分並不集中在單個的軟體生存週期裡，而是並行進行的生產、檢查和控制活動。
軟體開發人員在各個階段中以文件作為前階段工作成果的體現和後階段工作的依據，這個作用是顯而易見的。軟體開發過程中軟體開發人員需制定一些工作計畫或工作報告，這些計畫和報告都要提供給管理人員，並得到必要的支援。管理人員則可通過這些文件了解軟體開發專案安排、進度、資源使用和成果等。
軟體開發人員需為使用者了解軟體的使用、操作和維護提供詳細的資料，我們稱此為使用者文件。
· 可行性研究報告：說明該軟體開發專案的實現在技術上、經濟上和社會因素上的可行性，評述為了合理地達到開發目標可供選擇的各種可能實施的方案，說明並論證所選定實施方案的理由。
· 專案開發計畫：為軟體專案實施方案制定出具體計畫，應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬體及軟體資源等。專案開發計畫應提供給管理部門，並作為開發階段評審的參考。
· 軟體需求說明書：也稱軟體規格說明書，其中對所開發軟體的功能、效能、使用者介面及執行環境等作出詳細的說明。
· 資料要求說明書：該說明書應給出資料邏輯描述和資料採集的各項要求，為生成和維護系統資料文捲作好準備。
· 概要設計說明書：該說明書是概要設計階段的工作成果，它應說明功能分配、模組劃分、程式的總體結構、輸入輸出以及介面設計、執行設計、資料結構設計和出錯處理設計等礎。
· 詳細設計說明書：描述每一模組是怎樣實現的，包括實現演算法、邏輯流程等。
·使用者手冊：本手冊詳細描述軟體的功能、效能和使用者介面，使使用者了解如何使用該軟體。
· 操作手冊：本手冊為操作人員提供該軟體各種運**況的有關知識，特別是操作方法的具體細節。
· 測試計畫：為做好組裝測試和確認測試，需為如何組織測試制定實施計畫。計畫應包括測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差範圍等。
· 測試分析報告：測試工作完成以後，應提交測試計畫執**況的說明。對測試結果加以分析，並提出測試的結論意見。
· 開發進度月報：該月報系軟體人員按月向管理部門提交的專案進展情況報告。報告應包括進度計畫與實際執**況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。
· 專案開發總結報告：軟體專案開發完成以後，應與專案實施計畫對照，總結實際執行的情況，如進度、成果、資源利用、成本和投入的人力。此外還需對開發工作作出評價，總結出經驗和教訓
· 哪些需求要被滿足，即回答"做什麼?"
· 所開發的軟體在什麼環境中實現以及所需資訊從**來，即回答"從何處?"
· 某些開發工作的時間如何安排，即回答"何時幹?"
· 某些開發(或維護)工作打算由"誰來幹?" · 某些需求是怎麼實現的?
· 為什麼要進行那些軟體開發或維護修改工作? 上述十三個文件都在一定程度上回答了這六個方面的問題。
電子工藝實習課程設計報告
目錄 1 實習目的 2 工作方框和原理圖 3 實習任務和基本要求 4 實習內容及過程 5 組裝易出現的問題 6 收音機修理檢測方法 7 實習總結 1.實習目的 1.了解常用電子器件的類別 型號 規格 效能及其使用範圍，能查閱有關的電子 器件圖書。能夠正確識別和選用常用的電子器件，並且能夠熟練使用萬用...
生產實習課程說明 2019
09級光電生產實習課 課程說明 以學校學院規定為準 一.必修課 考勤 考勤表 考試 成績登記表 二.教師 總負責 江紹基 133雷射所508室 1 南校區真空鍍膜室 陳少飛 159 2 南校區雷射器加工室 曾長髮 137 3 東校區led室 劉立林 135 三.學生 09級光資訊 逸仙班 物理學專業...
生產運作課程設計實習報告
長春大學光華學院 商學院生產運作管理 課程設計報告 一 課程設計的目的 我們在學完 生產與運作管理 專業課程後，進行了本次生產運作管理的課程設計。生產運作管理課程設計是培養我們綜合分析和解決生產運作管理實際問題能力的乙個重要的實踐性教育環節。通過設計鞏固專業基礎理論，培養與考核我們理論與實際相結合的...