前提:
好的開始是成功的一半。謹遵師傅教導:做一件事情之前進行巨集觀把握,了解全域性,這便是編寫文件成功的一半。
過程:整個機房收費系統文件的成功編寫歷時大約10天的時間,針對此專案的學習做了兩個方面的是計畫,第一,機房收費系統文件編寫;第二,機房收費系統文件完善驗收。在機房收費系統文件編寫期間,
第一:編寫的主要文件
第二:根據《軟體工程文件模板》和《文件樣本》,了解到各個文件要編寫的主要內容:
(1)可行性研究報告:<1>引言 <2>前提 <3>現有系統的分析 <4>所建議的系統 <5>其他系統方案 <6>投資與效益 <7>社會因素分析 <8>結論
(在可行性研究報告中最主要的是關於技術與經濟方面的內容)
(2)專案開發計畫:<1>引言 <2>概述 <3>實施計畫 <4>支援條件 <5>專題計畫要點
(3)軟體需求說明書:<1>引言 <2>任務 <3>需求規定 <4>執行環境要求
(4)概要設計說明書:<1>引言 <2>總體設計 <3>介面設計 <4>執行設計 <5>系統資料結構 <6>系統出錯處理
(6)資料庫設計說明書:<1>引言 <2>外部設計 <3>結構設計 <4>運用設計
(7)資料要求說明書:<1>引言 <2>資料的邏輯描述 <3>資料的採集
(8)測試計畫:<1>引言 <2>計畫 <3>測試設計 <4>評價準則
(9)測試分析報告:<1>引言 <2>測試概要 <3>結果及分析 <4>軟體功能 <5>分析摘要 <6>資源消耗
(10)專案開發總結報告:<1>引言 <2>實際開發結果 <3>開發工作評價 <4>經驗與教訓
(11)操作手冊:<1>引言 <2>軟體徵述 <3>安裝與初始化 <4>執行說明 <5>非常規過程 <6>遠端操作
(12)使用者手冊:<1>引言 <2>用途 <3>執行環境 <4>使用過程
(13)開發進度月報:<1>標題 <2>工作進度與狀態 <3>資源耗用與狀態 <4>經費支出與狀態 <5>下個月的工作計畫 <6>建議
第一,在編寫文件過程中所遇到的問題:
(1)各個文件的預期讀者混亂 (2)每個文件中用到的專門術語的定義不知該如何著手
(3)使用者手冊與操作手冊的區別 (4)資料精度應該如何認識
(5)投資與效益分析的依據 (6)各個文件中用到的圖形的規範
第二,在實際文件的編寫過程中,對之前的困惑有了更加深刻的了解:
(1)各個文件的預期讀者是交叉的並沒有明顯的界限,領導階層的比如專案經理或者ceo從他們的身份出發,所有的文件他們都有許可權檢視,但是他們主要的檢視的是整個專案開發過程中的一些巨集觀的文件,比如可行性分析報告、專案開發計畫、開發進度月報;關於測試分析報告與測試計畫自然主要側重於測試人員檢視的;關於概要設計說明書、詳細設計說明書、資料庫設計說明書、資料要求說明書傾向於系統設計人員檢視;關於操作手冊和使用者手冊偏向於使用者檢視。
(2)使用者手冊和操作手冊有乙個明顯的區別在於:使用者手冊比操作手冊多了關於使用者在使用過程中遇到問題時的解決方案。
(3)投資與效益分析的依據主要根據系統開發的實際情況來進行計算的,比如實際的投資預算、實際的資源消耗、實際開發進度等,目前由於還沒有進入實際的專案開發過程中所以目前文件中關於投資與效益的分析可謂是稍微結合實際與想象的。
第一,每個文件中使用者的專門術語的定義是一些縮略語,比如tgb代表提高班,dbms代表資料庫管理系統諸如此類的定義
第二,資料精度的編寫主要側重於金額、時間等數值型的相關說明
第三,使用者手冊與操作手冊的關係:
<1>操作手冊是使用者手冊的一部分
<2>操作手冊是系統級別的文件,使用者手冊是需求級別的文件
<3>操作手冊講述的是如何操作該系統的某個頁面;使用者手冊是在使用者想做什麼事情,在這樣的前提下引導使用者去操作該系統完成這樣的需求
<5>使用者手冊是一套成熟的流程模式,包括系統操作說明,伺服器配置、系統安裝、操作、維護等方面
感受:
(1)在第一次接觸文件時,編寫的主要目的是要明白各個文件的預期讀者和主要內容。
機房收費系統文件總結
軟體工程的學習使我對軟體的規範化生產,有了較為初步的認識,而機房收費系統文件則是對軟工的一種表現形式,把軟工中的那些理論用文字表現在書面上。其實這些說著都特容易,但真正寫出來,卻相當的不容易啊。而後來的軟工總結,對前面學習的一種梳理,又了解了不少的東西。到文件的編寫,剛開始無從下手,到網上找資料吧,...
機房收費系統文件總結
從7月29日到8月2日總共用了五天的時間對 機房收費系統 的文件進行了初次的編寫,運用自己在軟體工程中學到的知識,實踐了一把 軟體工程的理論非常的枯燥,但是在指導系統的製作的過程中發揮著相當重要的作用。這次用了將近一周的時間寫 機房收費系統 文件,對 機房收費系統 又有了乙個全新的認識,從系統功能之...
機房收費系統文件總結
機房收費系統第一遍寫文件過去有一段時間了,前幾天師哥師姐們又給我們十期全體補充了一次營養,通過這次組織的交流會活動,忽然意識到自己真的是 學過了 學了 過了 當師哥師姐們讓我們自告奮勇總結每個文件的中心內容時,將近一百人的教室幾乎是鴉雀無聲啊。我的大腦開始使勁兒的翻箱倒櫃,可對寫過的文件的記憶還是零...