軟工文件介紹

2022-09-07 19:12:11 字數 3446 閱讀 4207

軟工文件總結

開始寫軟工文件之前,需明確各個文件的作用,和預期讀者,在網上搜到一篇總結很不錯的部落格,分享給大家!

文件:是軟體開發使用和維護中的必備資料。

文件是指與軟體系統及其軟體工程過程有關聯的文字實體。文件的型別包括軟體需求文件,設計文件,測試文件,使用者手冊等。其中的需求文件,設計文件和測試文件一般是在軟體開發過程中由開發者寫就的,而使用者手冊等非過程類文件是由專門的非技術類寫作人員寫就的。

文件能提高軟體開發的效率,保證軟體的質量,而且在軟體的使用過程中有指導、幫助、解惑的作用,尤其在維護工作中,文件是不可或缺的資料。

軟體文件

文件是一種對軟體系統的書面描述;

文件應當精確地描述軟體系統;

軟體文件是軟體工程師之間用作溝通交流的一種方式;

文件的呈現方式有很種,可以是傳統的書面文字形式或圖表形式,也可是動態的網頁形式。

軟工文件按照作用分為三類:開發文件,管理文件,使用者文件。

軟工文件共有13個文件,它們各自的作用和預期讀者,下面來說:

(1)      可行性研究報告:

作用:可行性研究報告是從事一種經濟活動(投資)之前,雙方要從經濟、技術、生產、供銷直到社會各種環境、法律等各種因素進行具體調查、研究、分析,確定有利和不利的因素、專案是否可行,估計成功率大小、經濟效益和社會效果程度,為決策者和主管機關審批的上報檔案。可行性研究報告的基本內容就是報告的正文部分所要體現的內容。它是結論和建議賴以產生的基礎,要求運用大量的資料資料論證擬建專案是否可行。當專案的可行性研究完成了所有系統的分析之後,應對整個可行性研究提出綜合分析評價,指出優缺點和建議。

預期讀者: 系統管理人員、開發人員和維護人員。

(2)      專案開發計畫:

作用:專案計畫是乙個軟體專案進入系統實施的啟動階段,主要進行的工作包括:確定詳細的專案實施範圍、定義遞交的工作成果、評估實施過程中主要的風險、制定專案實施的時間計畫、成本和預算計畫、人力資源計畫等。專案計畫的目標是為專案負責人提供乙個框架,使之能合理地估算軟體專案開發所需的資源、經費和開發進度,並控制軟體專案開發過程按此計畫進行。

預期讀者:系統分析員和開發人員

(3)      軟體需求說明書:

作用:軟體需求說明書的編制是為了使使用者和軟體開發者雙方對該軟體的初始規定有乙個共同的理解, 使之成為整個開發工作的基礎。包含硬體、功能、效能、輸入輸出、介面介面、警示資訊、保密安全、資料與資料庫、文件和法規的要求。

預期讀者使用者、專案管理人員、文件編寫人員、需求分析人員

(4)      概要設計說明書:

作用:概要設計說明書是說明對程式 系統的設計考慮,包括程式系統的基本處理流程、程式系統的組織結構、模組劃分、功能分配、介面設計、執行設計、資料結構設計和出錯處理設計等,為程式的詳細設計提供基礎。在需求分析基礎上得到的物理模型確定乙個合理的軟體系統的體系結構。包括合理地劃分組成系統的模組、模組間的呼叫關係及其模組間的介面,並且為軟體系統提供所用的資料結構或者資料庫結構。

預期讀者專案設計和專案編碼人員

(5)      詳細設計說明書:

作用:詳細設計說明書又可稱程式設計說明書。它是說明乙個軟體系統各個層次中的每乙個程式 ,每個模組或子程式的設計考慮。在概要設計說明書的基礎上對不同的模組功能進行明確的系統結構定位,如:功能、效能、輸入輸出、演算法、流程邏輯、介面、儲存、注釋、限制、測試等。

預期讀者程式開發人員和程式測試人員

(6)      資料庫設計說明書:

作用:是對於設計中的資料庫的所有標識.邏輯結構和物理結構做出具體的設計規定。

預期讀者:資料庫設計師、資料庫管理員。

(7)      資料要求說明書:

作用:是為了提供關於處理資料的描述和資料採集要求的技術資訊。

預期讀者:資料庫設計人員、系統測試人員

(8)      測試計畫:

作用:測試計畫描述了要進行的測試活動的範圍、方法、資源和進度的文件;是對整個資訊系統應用軟體組裝測試和確認測試。它確定測試項、被測特性、測試任務、誰執行任務、各種可能的風險。測試計畫可以有效預防計畫的風險,保障計畫的順利實施。它為測試各項活動制定乙個現實可行的、綜合的計畫,包括每項測試活動的物件、範圍、方法、進度和預期結果;為專案實施建立乙個組織模型,並定義測試專案中每個角色的責任和工作內容;識別出測試活動中各種風險,並消除可能存在的風險,降低由不可能消除的風險所帶來的損失。

預期讀者:系統程式設計人員和系統測試人員

(9)      測試分析報告:

作用:測試分析報告是在測試分析的基礎上,對測試的結果以及測試的資料等加以記錄和分析總結。它也是測試過程中的乙個重要環節,同時,它也是對軟體效能的乙個總的分析和認可及對不足之處的說明。它有利於今後軟體開發者閱讀原程式,根據測試提供的資料和結果,分析原**,掌握各函式的功能和侷限性。

預期讀者軟體開發人員

(10)  專案開發總結報告:

作用:要是總結本軟體的開發經驗和總結所學到的知識,以及對乙個系統的軟體設計的總體感悟,並將軟體設計過程中遇到的問題加以闡述和說明。

預期讀者:軟體的開發人員

(11)  操作手冊:

作用:提供了產品具有哪些功能,以及如何正確地、有效地來使用這些功能。說明了使用方法和步驟,便於使用者使用。

預期讀者:使用者

(12)  使用者手冊:

作用:是詳細描述軟體的功能、效能和使用者介面,使使用者了解到如何使用該軟體。它要求手冊的完整性,手冊的描述與軟體實際功能的一致性,手冊的易理解性,手冊提供學習操作的例項。

預期讀者:使用者

(13)  開發進度月報:

作用:是及時向有關管理部門匯報專案開發的進展和情況,以便及時發現和處理開發過程**現的問題。

預期讀者:軟體的開發人員

總結:文件指導著軟體開發的過程,有了文件我們才能系統的,完善的對軟體進行開發和維護等,文件貫穿於整個軟體工程。

軟工 軟工文件總結

1 定義 軟工文件是與程式開發 維護和使用有關的 材料,記錄了軟體開發活動和階段性成果 理解軟體所必需的闡述性資料。2 目的與作用 1 目的是為了保證專案開發的成功,最經濟的花費這些投資,並且便於執行和維護,在開發的每乙個階段都需要編制文件。2 作用是 a 作為開發人員在一定階段內的工作成果和結束標...

軟工文件總結

軟體工程大體分為六個週期 可行性研究 分析 設計 測試 編碼 執行維護,每個階段都會產生相應的文件。做完機房收費系統,但是只是敲一下 沒想到還有那麼多的文件要寫,文件已經寫完了,印象最深的還是那麼多令人眼花繚亂的圖。針對軟體工程整個階段做一下最後的總結。需求分析 需求分析主要是對功能的描述,文件中穿...

軟工文件總結

軟工文件已經結束有一段時間了,一直也沒有寫總結做的挺不好的!反思一下自己!根據文件的產生和使用範圍分為三類 我覺得軟體需求說明書既是開發文件也是使用者文件,因為軟體需求說明書是由開發者和使用者共同決定的。如果要做乙個軟體就要先做一下市場調查,了解使用者的需求,使用者和開發者共同商討的乙個平衡點這就產...