1、精選優質文檔-傾情為你奉上遼 寧 工 業 大 學 軟件文檔寫作 實訓報告題目： 教師信息管理系統軟件文檔 院（系）: 軟件學院 專業班級: 學 指導教師: 起止時間: 2012.11.26-2012.12.02 實訓任務及評語院（系）：軟件學院 教研室：軟件教研室學 號實訓題目 教師信息管理系統軟件文檔實訓任務實訓任務及要求：1、 了解軟件開發周期各階段的文檔。2、 掌握各文檔闡述的內容及作用。3、 了解文檔所采用的國際、國家等相關標準。4、 了解各文檔所涉及的軟件知識。5、 掌握各文檔采用的描述工具。6、 具體編寫出2個主要的軟件文檔。實訓過程中，要嚴格遵守實訓的時間安排，聽從指導教師的指導

2、。正確地完成上述內容，記錄實習日記，規范完整地撰寫出實訓報告。幾個人為一組完成一個相對完整的軟件系統開發文檔，組內成員編寫的文檔不能重復，文檔要嚴格按照所采用的標準編寫，圖表布局要合理規范。指導教師評語及成績成績： 指導教師簽字： 年 月 日專心-專注-專業目 錄第1章 實訓目的與要求1.1 實訓目的 本實訓要求學生通過具體的實例，模仿軟件開發過程中軟件文檔寫作的具體方法和步驟，分組完成一套較為簡單軟件文檔，具體要達到以下幾點目的。1、了解軟件開發周期各階段的文檔。2、掌握各文檔闡述的內容及作用。3、了解文檔所采用的國際、國家等相關標準。4、了解各文檔所涉及的軟件知識。5、掌握各文檔采用的描述

3、工具。6、具體編寫出2個主要的軟件文件。 1.2 實訓的實驗環境學校圖書館，互聯網查詢環境，具有軟件圖表制作軟件的計算機。1.3 實訓的預備知識 要求學生修完全部專科所有課程，具有較全面計算機軟件知識和一定的文獻檢索能力及動手實踐能力。該實訓應安排在畢業設計之前進行。1.4 實訓要求實訓過程中，要嚴格遵守實訓的時間安排，聽從指導教師的指導。正確地完成上述內容，記錄實習日記，規范完整地撰寫出實訓報告。 第2章 軟件文檔及其組成2.1軟件文檔的作用及分類作用：在軟件的生產過程中，總是伴隨著大量的信息要記錄、要使用。因此，軟件文檔在產品的開發生產過程中起著重要的作用。 1.提高軟件開發過程的能見度。

4、把開發過程中發生的事件以某種可閱讀的形式記錄在文檔中。管理人員可把這些記載下來的材料作為檢查軟件開發進度和開發質量的依據，實現對軟件開發的工程管理。 2.提高開發效率。軟件文檔的編制，使得開發人員對各個階段的工作都進行周密思考、全盤權衡、從而減少返工。并且可在開發早期發現錯誤和不一致性，便于及時加以糾正。 3.作為開發人員在一定階段的工作成果和結束標志。 4.記錄開發過程中的有關信息，便于協調以后的軟件、開發、使用和維護。 5.提供對軟件的運行、維護和培訓的有關信息，便于管理人員、開發人員、操作人員、用戶之間的協作、交流和了解。使軟件開發活動更科學、更有成效。 6.便于潛在用戶了解軟件的功能、

5、性能等各項指標，為他們選購符合自己需要的軟件提供依據。文檔在各類人員、計算機之間的多種橋梁作用中看出：既然軟件已經從手工藝人的開發方式發展到工業化的生產方式，文檔在開發過程中就起到關鍵作用。從某種意義上來說，文檔是軟件開發規范的體現和指南。按規范要求生成一整套文檔的過程，就是按照軟件開發規范完成一個軟件開發的過程。所以，在使用工程化的原理和方法來指導軟件的開發和維護時，應當充分注意軟件文檔的編制和管理。 分類：軟件文檔從形式上來看，大致可分為兩類：一類是開發過程中填寫的各種圖表，可稱之為工作表格；另一類是應編制的技術資料或技術管理資料，可稱之為文檔或文件。軟件文檔的編制，可以用自然語言，特別設

6、計的形式語言，介于兩者之間的半形式語言(結構化語言)，各類圖形表示。表格來編制文檔。文檔可以書寫，也可以在計算機支持系統中產生，但它必須是可閱讀的。按照文檔產生和使用的范圍，軟件文檔大致可分為三類： 1.開發文檔：這類文檔是在軟件開發過程中，作為軟件開發人員前一階段工作成果的體現和后一階段工作依據的文檔。包括軟件需求說明書、數據要求說明書、概要設計說明書、詳細設計說明書、可行性研究報告、項目開發計劃。 2.管理文檔：這類文檔是在軟件開發過程中，由軟件開發人員制定的需提交人員的一砦工作計劃或工作報告。使管理人員能夠通過這些文檔了解軟件開發項目安排、進度、資源使用和成果等。包括項目開發計劃、測試計

7、劃、測試報告、開發進度月報及項目開發總結。 3.用戶文檔：這類文檔是軟件開發人員為用戶準備的有關該軟件使用、操作、維護的資料。包括用戶手冊、操作手冊、維護修改建議、軟件需求說明書。2.2軟件文檔所采用的標準 ISO標準是International Organization for Standardization的英文縮寫,即國際標準化組織。它的宗旨是在全世界促進標準化及有關活動的發展，以便于國際物資；交流和服務，并擴大知識、科學、技術和經濟領域中的合作。 GB/T 85662006范圍根據GB/T 85662001信息技術軟件生存周期過程的規定，主要對軟件的開發過程和管理過程應編制的主要文檔及

8、其編制的內容、格式規定了基本要求。本標準原則上適用于所有類型的軟件產品的開發過程和管理過程。使用者可根據實際情況對本標準進行適當剪裁(可剪裁所需的文檔類型，也可對規范的內容作適當裁剪)。軟件文檔從使用的角度大致可分為軟件的用戶需要的用戶文檔和開發方在開發過程中使用的內部文檔(開發文檔)兩類。供方應提供的文檔的類型和規模，由軟件的需方和供方在合同中規定。2.2 軟件文檔的主要內容軟件文檔主要分為開發文檔和產品文檔其中開發文檔又分為：功能要求投標方案和需求分析技術分析系統分析數據庫文檔功能函數文檔界面文檔編譯手冊QA文檔項目總結等而產品文檔則分為：產品簡介產品演示疑問解答功能介紹技術白皮書評測報告

9、安裝手冊使用手冊維護手冊用戶報告銷售培訓等。其中主要的有：1、功能要求：來源于客戶要求和市場調查，是軟件開發中最早期的一個環節。2、需求分析包括產品概述、主要概念、操作流程、功能列表和注意事項系統環境等。3、技術分析包括技術選型、技術比較、關鍵技術問題的解決、技術風險、等。4、系統分析：包括功能實現，模塊組成、函數接口、數據字典、開發需要考慮問題等。5、數據庫文檔：包括數據庫名稱、表明、字段名、字段說明、字段數值計算公式等。6、功能函數文檔：包括變量名、功能、函數名、參數、如何調用、備注、注意事項等。7、項目總結：包括項目簡介、項目功能列表、項目結構特點、對以后的項目建議等。第3章 實 例3.

10、1 教師信息管理系統實例輸入信息個人資料授權課程特殊補助收入總匯提示錯誤登錄系統選擇要進行的操作輸入密碼碼教師信息管理職稱信息管理帳號管理退出提示錯誤設置賬號刪除查詢添加退出可行性研究報告1引言1.1編寫目的 可行性研究的目的是為了對問題進行研究，以最小的代價在最短的時間內研究問題是否可以得到解決。經過對此項目進行詳細調查研究，初擬系統實現報告，對軟件開發中將要面臨的問題及其解決方案進行初步設計及合理安排。明確開發時間精力風險。編碼可行性研究報告的目的是為了對本系統的可行性進行一下探討，論證實現本項目的可能性，和一些前期的準備工作及工作條件，并且為下一步設計打下鋪墊.1.2背景待開發的軟件系統

11、的名稱：教師信息管理系統。本項目開發小組人員：楊娜，白晉偉，龐珊珊，齊峰，文烈用戶：各大院校1.3定義Teacher Manage:教師管理。1.4參考資料學生管理信息系統公司職員管理系統實用軟件文檔寫作2可行性研究的前提2.1要求A.主要功能：為教師信息管理員提供查看各方面信息的服務，從而進行全局掌控的功能； 為信息管理人員提供查看和管理教師信息的變動便于記錄，管理教師在校的活動情況的功能；為學生提供查看教師的精品課程的功能。B.性能：管理人員必須準確無誤的登記教師的信息，并且快速地傳送至總服務器，對教師 的信息要及時更新，并且應該達到1000人同時能正常快速地訪問服務器。C.輸出：數據準確

12、，完整，詳細D.輸入：方便，簡介，迅速E.安全與保密要求：非信息管理人員無法使用此系統，各部門的管理人員擁有與其部門相對應模塊的使用權限，無法越權操作；主管有權查看各部門信息，但無法隨意修改；F.完成期限：預計一個月2.2目標 為各高校的教師構建一個完整的教師信息記錄平臺，以便快速的查閱教師的信息和管理教師在校的情況。在開發過程中做到： a.最大程度的減少資金與人員的利用； b.在設計系統處理速度時做到考慮周全使系統的整體運行速度全面提高； c.在進行管理員操作時限制條件應準確無誤； d.在人員利用率方面，使用最少的開發人員完成系統開發。2.3條件、假定和限制 a.所建議系統的運行壽命的最小值

13、：2年； b.進行系統方案選擇比較的時間：2012-11-30； c.經費、投資方面的來源：投資院校； d.硬件：SQL server 2000；運行環境：windows xp/win 7/Vista可利用的信息和資源； 系統投入使用的最晚時間：2012-12-02。2.4進行可行性研究的方法 可行性研究的方法是通過對在校的所有教師進行問卷調查登記而得到教師對此系統的信任度關注度及依賴度，以及對此系統的各種期望。通過建模分析，得出取代舊系統的新系統的功能需求，成本分析，可行性分析。2.5評價尺度收益可行：效益/成本>1技術可行：現有技術可完全承擔開發任務。操作可行：軟件能被信息管理工作人

14、員快速接受3對現有系統的分析 隨著社會的快速發展，教育已經成為了一個國家的標志，為保證了高水平的教學質量。為了不斷提高教學質量，提高教師隊伍水平，不斷擴大辦學規模，合學院成為國內知名、省內一流的高職學院。為保證戰其實現，學院領導認識到提高教學教學管理水平的必要性，為此，建立管理信息系統，使教學管理工作規范化、制度化、程序化，促進學院管理的基礎工作，提高信息處理速度和準確性，及時掌握學院內外部環境的各種信息成為關鍵?？蛻魴C端顯示數據客戶機端顯示數據客戶機端顯示數據客戶機端顯示視頻產生報表產生報表產生報表產生報表數據庫計算機財務系建工系管理系查詢請求查詢，更新信息查詢，更新信息查看監控錄像3.1處

15、理流程和數據流程3.2工作負荷現有系統中主要由系主任、教務員和教研室主任負責教學管理工作，具體分工如下：系主任：負責教學計劃的審核、教學任務的安排、教學管理各項工作的督查。教務員：負責教學管理的各項具體工作，教學任務實現的檢查、記錄。教研室主任：負責教學計劃的制訂修訂、配合系主任完成教學任務的安排。3.3費用開支3.3費用開支人員：教學管理人員多名，由學院支付工資設備：使用4臺PC機、一臺打印機進行教學信息處理空間：一間辦公室開支以及開 支總額。3.4人員PC機維護：1人3.5設備 PC機：4臺打印機：1臺3.6局限性某些學院現行的管理工作存在主要問題是：1業務管理工作缺乏規范性，隨意性大。2

16、業務管理部門各自政，數據資料被職能人員獨自使用，造成具體工作對個別人員的依賴性大。3部門之間交流信息少，信息渠道不暢，工作不易協調。4數據處理手工操作，工作量大，出錯率高。5學院領導對整個學校的各項管理信息掌握不及時、不準確，影響決策。4所建議的系統4.1對所建議系統的說明教師信息的管理系統的終端是安裝了windows操作系統的PC機，主要任務是向信息管理數據庫的主服務器傳送數據和查看主服務器的數據。信息修改管理方面，管理人員將教師的錯誤信息通過PC機輸入到主服務器中。教師查看是教師通過Internet訪問服務器，輸入查詢的部分信息到主服務器中，主服務器將符合查詢的信息資料服務器提取出來顯示在

17、終端機上，達到查看的目的。管理員可以通過PC機向主服務器發送查看信息的請求，主服務器會將管理員想查找的信息發送到你的PC機上。學生訪問管理方面，學生訪問教師管理系統只有訪問和查看教師信息的權限 ，學生向服務器發送箱要查詢教師的部分信息，主服務器將符合條件的教師信息提取出來最終顯示在終端上。4.2處理流程和數據流程4.3改進之處 教師信息管理系統是基于網絡的新型系統，系統規模雖小，但功能齊全。實現了教學管理各項信息的計算機處理，便教學管理人員和學生進行查閱，實現信息的共享。4.4影響4.4.1對設備的影響 由于采用C/S結構，需要服務器一臺，可以另購，或直接使用學院現有的網絡中心的服務器?？蛻魴C

18、可以使用辦公室現有PC機。4.4.2對軟件的影響需要在服務器中安裝SQL Server服務器?？蛻舳藷o要求。4.4.3對用戶單位機構的影響本系統的使用，只需要教學管理人員掌握基本的計算機操作即可。4.4.4對系統運行過程的影響無要求。4.4.5對開發的影響需要教務員提供系統所需原始數據。4.4.6對地點和設施的影響無要求。4.4.7對經費開支的影響本系統所需要的硬件和軟件環境可以使用學院現有的資源，軟件開發由計算機系組織專業技術人員2人進行開發，學院只需要2人開發工資5000元。4.5局限性 該學院現行的管理工作存在主要問題是：1業務管理工作缺乏規范性，隨意性大。2業務管理部門各自政，數據資料

19、被職能人員獨自使用，造成具體工作對個別人員的依賴性大。3部門之間交流信息少，信息渠道不暢，工作不易協調。4數據處理手工操作，工作量大，出錯率高。5學院領導對整個學校的各項管理信息掌握不及時、不準確，影響決策。4.6技術條件方面的可行性1）.在當前的限制條件下，該系統的功能目標能達成2）.開發這個軟件并不需要大量的工作人員，而且對工作人員的能力要求沒那么高，所以 在工作人員的效率和質量方面是沒有問題的3）.由于該軟件并不是特別難，所以在一定數量的工作人員下，并不會花費太多的時間。5可選擇的其他系統方案5.1可選擇的系統方案1 在查詢的時候可以添加一些條件不符合的輸入，我們可以添加一些詞語聯想的功

20、能來輔助進行查詢教師的信息。6投資及效益分析6.1支出6.1.1基本建設投資 網絡設備：1200 輔助配置：100 共計：13006.1.2其他一次性支出硬件設備：計算機，打印機，5006.1.3非一次性支出經常性支出： 人工費用： 5（人）*1（月）*500（元）=2500 其他不可預知性的額外支出： 300 支出共計：28006.2收益6.2.1一次性收益0元6.2.2非一次性收益經常性收益（按銀行利率：1%）：減少員工5人（500元/人）五年收益：5人*800元/人=2500元。 經常性收益共計 ： 1萬6.2.3不可定量的收益不定量收益；因服務質量提高增加的用戶10%：1萬；收益共計：

21、3萬6.3敏感性分析系統設計周期為五年，估計最長可達9年；處理速度：一般輸入速度<3秒；說句查詢速度：<5秒；7社會因素方面的可行性7.1法律方面的可行性所有軟件都選用正版；所有技術資料都由提出方保管；合同制定確定違約責任。7.2使用方面的可行性普通的管理員都能熟練掌握系統的管理工作；領導等管理階層能順利方便的查到一切教師的變動和教師的授課情況以及各個教師的福利及工資等。8結論由于投資效益比遠大于100%, 技術、經濟、操作都有可行性， 能夠有效的節省人力物力，可以進行開發。3.2教師信息管理系統實例概要設計說明書1引言1.1編寫目的為明確教師信息管理系統的系統結構、安排項目規劃與

22、進度、制定詳細測試計劃、組織軟件開發與測試，特撰寫本文檔。本文檔供項目經理、設計人員、開發人員參考。1.2背景開發軟件名稱：教師信息管理系統項目任務提出者：遼寧工業大學軟件學院軟件工程專業項目開發者：楊娜，白晉偉，龐珊珊，齊峰，文烈用戶：各所院校實現軟件者：楊娜，白晉偉，龐珊珊，齊峰，文烈項目與其他軟件，系統的關系：該系統需要在學生成績管理系統，學生選課系統等已有系統直接復制數據，所以在定義數據時要與已有系統相兼容。本系統采用VB作為前臺，Microsoft SQL Server 2000作為后臺數據庫。 1.3定義Teacher Manage:教師管理。1.4參考資料學生管理信息系統公司職員

23、管理系統實用軟件文檔寫作 編號hust_FSR：可行性研究報告 鎮祎編號 hust_xiangmujihua：項目計劃說明書 汪瑤 編號 hust_xuqiuguifan需求規范說明書 歐高炎2總體設計2.1需求規定輸入功能性能要求：教師信息的錄入要符合客觀事實輸出功能性能要求：所有教師信息以及學生選課的信息應符合實際要求處理的功能性能要求：教師授課與教師信息應相匹配2.2運行環境SQL server 2000；運行環境：windows xp/win 7/Vista可利用的信息和資源； 系統投入使用的最晚時間：2012-12-02。2.3基本設計概念和處理流程輸入信息個人資料授權課程特殊補助收

24、入總匯提示錯誤登錄系統選擇要進行的操作輸入密碼碼教師信息管理職稱信息管理帳號管理退出提示錯誤設置賬號刪除查詢添加退出針對本系統的教務管理人員、學生、教師三種不同的角色，系統的處理流程如下圖所示： 圖2.1教務管理人員登錄時的系統流程圖2.4結構用一覽表及框圖的形式說明本系統的系統元素（各層模塊、子程序、公用程序等）的劃分，扼要說明每個系統元素的標識符和功能，分層次地給出各元素之間的控制與被控制關系.2.5功能器求與程序的關系本條用一張如下的矩陣圖說明各項功能需求的實現同各塊程序的分配關系：程序1程序2程序n功能需求1功能需求2功能需求n2.6人工處理過程說明在本軟件系統的工作過程中不得不包含的

25、人工處理過程（如果有的話）。2.7尚未問決的問題說明在概要設計過程中尚未解決而設計者認為在系統完成之前必須解決的各個問題。3接口設計3.1用戶接口說明將向用戶提供的命令和它們的語法結構，以及軟件的回答信息。3.2外部接口說明本系統同外界的所有接口的安排包括軟件與硬件之間的接口、本系統與各支持軟件之間的接口關系。3.3內部接口說明本系統之內的各個系統元素之間的接口的安排。4運行設計4.1運行模塊組合說明對系統施加不同的外界運行控制時所引起的各種不同的運行模塊組合，說明每種運行所歷經的內部模塊和支持軟件。4.2運行控制說明每一種外界的運行控制的方式方法和操作步驟。4.3運行時間說明每種運行模塊組合

26、將占用各種資源的時間。5系統數據結構設計5.1邏輯結構設計要點給出本系統內所使用的每個數據結構的名稱、標識符以及它們之中每個數據項、記錄、文卷和系的標識、定義、長度及它們之間的層次的或表格的相互關系。5.2物理結構設計要點給出本系統內所使用的每個數據結構中的每個數據項的存儲要求，訪問方法、存取單位、存取的物理關系（索引、設備、存儲區域）、設計考慮和保密條件。5.3數據結構與程序的關系說明各個數據結構與訪問這些數據結構的形式:6系統出錯處理設計6.1出錯信息用一覽表的方式說朗每種可能的出錯或故障情況出現時，系統輸出信息的形式、含意及處理方法。6.2補救措施說明故障出現后可能采取的變通措施，包括：

27、后備技術說明準備采用的后備技術，當原始系統數據萬一丟失時啟用的副本的建立和啟動的技術，例如周期性地把磁盤信息記錄到磁帶上去就是對于磁盤媒體的一種后備技術；降效技術說明準備采用的后備技術，使用另一個效率稍低的系統或方法來求得所需結果的某些部分，例如一個自動系統的降效技術可以是手工操作和數據的人工記錄；恢復及再啟動技術說明將使用的恢復再啟動技術，使軟件從故障點恢復執行或使軟件從頭開始重新運行的方法。6.3系統維護設計說明為了系統維護的方便而在程序內部設計中作出的安排，包括在程序中專門安排用于系統的檢查與維護的檢測點和專用模塊。 各個程序之間的對應關系，可采用如下的矩陣圖的形式； 第4章 實訓日記一

28、周緊張的實習過去了，在這期間我學會了軟件文檔的編寫，并且對前面學過的許多課程有了更為深刻的理解，讓我真正體會到了軟件開發的整個過程真是不易。整個過程是我受益匪淺，綜合起來，總結如下：第一，做事不能夠急于求成，越是急于求成心境就越是安靜不下來。這樣為課題的完成設置了許多的阻礙。而且，由于在開發系統前考慮的問題時比較片面，上手操作時相對來說就較盲目。給后面的開發帶來了很大的不便。但經過查一些相關資料，將問題一一解決了，使得后來的工作才得以順利進行。第二，在對理論知識的熟悉上也有要求，這也無疑是開發進度提升的難點。由于以前在學習過程中只是獨立的編制過一些較為簡易的程序，其實現的功能也是有限，從而要求

29、對語言的熟悉程序不高。然而這次設計，不但難度大時間短，而且還要求對一些算法比較熟悉，否則將延遲工作速度，必須停下來再去學習，后因時間問題，本系統還有一些不盡如意之處。通過這周的課程設計，我認識到了自己許多方面的不足。在編程過程中不仔細是很麻煩的，這將讓費許多的時間。這次實習給我敲響了警鐘以后一定要注意，要更加細心。總的來說，這次的實習設計為我進入下一個成長階段奠定了基礎。讓我對幾年來所學的專業課有了更為深刻的認識，使知識得到了融會貫通，得到了比以往學習任何一門課都有大的提高和進步。這次實習設計雖說不能堪稱完美，但我會在以后的時間里盡量的完善它，不斷的對它進行升級，解決系統可能出現的問題。第5章 實訓總結此次所實訓內容是編寫開發教師信息管理系統文檔，在老師指導、安排下，每組5人，小組內分工明確。     在分組的時候我們將題目分為五段：詳細設計與需求分析，概要設計+可行性分析，數據庫設計+操作手冊，詳細設計+測試分析。我組的教師信息管理系統在可行性分析階段我們用了2天，通過我們在對原有系統的調查，很快我們完成了可行性分析報告的編寫,可行性分析報告的目的是確定問題是否值得去解決,這個階段我們分析的很完美。其次進入項目開發階段,那天早