1. 程式人生 > >軟體工程各類開發文件的作用

軟體工程各類開發文件的作用

內容提綱:(1)軟體工程各類開發文件的目的與作用詳解

              (2)操作手冊與使用者手冊的區別。

一、《可行性研究報告》

可行性研究報告是在制定研發專案之前,以全面、系統的分析為主要方法,經濟效益為核心,對本專案實施的可能性、有效性、技術方案及技術政策進行具體、深入、細緻的技術論證和經濟評價,以求確定一個在技術上合理、經濟上合算的最優方案和最佳時機。分析專案是否具備開發的必要性與可行性。

可行性研究報告的預期讀者為系統管理人員、開發與運維人員。

簡而言之,就是分析可行性,確定最優方案。

二、《專案開發計劃書》

專案開發計劃的作用就是用檔案的形式,根據可行性研究推薦的可行方案,落實各項工作的負責人、參加人員(系統分析員、系統設計員、程式設計師、資料員等)以及各種資源(計算機硬體、軟體工具等)的需求,制定專案開發進度、驗收標準和成本概算等,以檔案形式記載下來,指導整個專案開發工作的順利進行,併為開發的下一步做準備。

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

通俗些講,就是根據可行性研究出來的最優方案,把工作內容分配下去。

三、《軟體需求說明書》

軟體需求說明書是需求分析階段的一個文件,是對軟體目標及範圍的求精和細化,深入描述軟體的功能和效能以及軟體的約束範圍,使使用者和軟體開發者對該軟體的初始規定有個大概瞭解,便於使用者、開發人員進行理解和交流。明確了開發軟體的方向,程式設計師要根椐需求規格說明書去開發軟體, 作為確認測試和驗收的依據,有利於對專案的回溯和指導後續的開發和維護。

    文件讀者:開發人員與使用者代表。

這個就是搞需求的,開發計劃書裡已經計劃好了你搞測試,我搞開發,他弄管理,好,那咱們開工吧,開工之前先搞清需求是啥,弄一個物理模型出來,就是

系統應該是怎麼樣的,這就是需求說明書。

四、《概要設計說明書》

概要設計說明書是在使用者的需求分析階段的基礎上,對系統做概要設計,為在需求分析階段得到的目標系統的物理模型確定一個合理的軟體系統的體系結構。包括合理地劃分組成系統的模組、模組間的呼叫關係及模組間的介面,並且為軟體系統提供所用的資料結構或者資料庫結構。從而為下一階段的詳細設計做參考,設計階段將以本文件為核心文件。

本文件的讀者是專案設計和專案編碼人員。

概要設計說明書階段已經規定了系統內、外部介面,並設計好資料庫。

五、《詳細設計說明書》

詳細設計說明書是在概要設計的基礎上進一步明確系統結構,表示出軟體結構的圖表,完成演算法設計、資料結構設計、物理設計等,詳細地描述的逐個模組,包括演算法和邏輯流程的具體實現方法,設計系統的物理模型等,為下一步系統的實現和測試做準備。開發人員在完成概要設計說明書的基礎上,在編碼階段可以把這個描述直接翻譯成用某種程式設計語言書寫的程式。詳細設計的結果基本上決定了最終程式程式碼的質量。詳細設計的目標不僅僅是在邏輯上正確的實現每個模組的功能,更重要的是設計出的處理過程應該儘可能簡明易懂。

編寫詳細設計說明說的目的就是為程式設計師寫出實際的程式程式碼提供依據。它是軟體詳細設計階段所有任務和所有相關人員(包括專案管理人員、軟體設計人員、軟體測試人員、文件編制人員和質量稽核人員),所需要的參考資料。

本文件的預期讀者是程式開發人員、程式測試人員與客戶。

詳細設計說明書對系統描述的細緻程度已經到了頂級了,所以有些人也形象的把詳細設計說明書的作用比喻成”後期需求方和開發方打嘴仗時的一個憑證“。詳細設計說明書一般是對大型系統準備的,如果是小系統的話,概要設計說明書就夠用了,詳細設計說明書可以省略。

六(1)、《資料庫設計說明書》

資料庫設計說明書描述了機房收費系統資料庫的設計,提供了資料庫設計的可視性以及軟體支援所需的資訊,應用於系統開發前期,為了讓參與本專案的專案的人員瞭解本系統的資料庫設計思路、資料庫整體架構及各種詳細資訊,也為了以後的各個專案可以參與借鑑該專案的經驗,將資料分析的結果進一步整理,對本系統資料庫的所有標識、邏輯結構和物理結構作用作出具體的設計規定和分析說明,形成最終的計算機模型,以便開發人員建立物理資料庫。  

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

這一階段是確定資料庫的邏輯結構和物理結構。

六(2)、《資料要求說明書》

編寫資料庫要求說明書的目的是明確系統中各項功能和非功能性需求實現時所需要的資料,根據此資料設計資料庫。同時為概要設計和詳細設計人員提供設計依據,其他本專案組的開發人員也可以參閱。定義總體要求,作為使用者和軟體開發人員之間相互瞭解的基礎;提供效能要求、初步設計和對使用者影響的資訊,作為開發人員進行設計和實施的基礎;作為總體驗證和確認的依據。

本文件的閱讀物件為:資料庫設計人員、系統測試人員

這一階段進一步確定了資料庫中的資料要求。

七、《測試計劃說明書》

制定該測試計劃書主要為了能夠對開發過程中的部分環節進行有序、高效地測試,最終可最大限度地發現軟體中的錯誤,並減少軟體中殘留的錯誤。描述了需要測試的特性、測試的方法、測試環境的規劃、測試用例的設計方法、明確測試策略、明確誰來完成每項任務以及需要制定應急方案的所有風險等。通過測試,驗證該機房管理系統系統模型已經達到設計的標準,交由專案負責人審閱並總結測試活動的成功經驗與不足,以便今後更好地開展測試工作。

本文件的預期讀者是系統程式設計人員和系統測試人員。

這一階段是確定如何對系統進行測試的。

八、《測試分析報告》

測試分析報告是在測試的基礎上,對測試的結果以及測試的資料等寫成文件,對發現的問題和缺陷加以記錄和分析總結,為糾正軟體的存在的質量問題提供依據,同時為軟體驗收和交付打下基礎。另外,它還有利於今後軟體開發者閱讀源程式,根據測試提供的資料和結果,分析原始碼,掌握各函式的功能和侷限性,從而縮短軟體開發者的在開發時間和所耗費的精力、資金。

本文件的預期讀者是軟體開發人員。

九、《專案開發總結報告》

系統的開發工作已經基本完成。寫此專案開發總結報告,以方便我們在以後的專案開發中來更好的實施專案的制定開發,讓我們在今後的專案開發中有更多的資料來規範我們的開發過程和提高我們的開發效率,從而創造更多公司效益。

預期讀者為相關軟體的開發人員。

對專案開發的總結。

十、《操作手冊》

操作手冊的目的在於告訴系統的使用者,系統提供了那些功能,以及如何正確地、有效地來使用這些功能。

預期讀者是系統使用者。

十一、《使用者手冊》

編寫此文件的主要目的是為了給使用者提供一個使用指南,以便為首次使用該系統的使用者說明使用方法,以及給已經使用過或者正在使用的使用者在使用過程中遇到問題時提供解決問題的方法。

預期讀者為系統使用者。

附:操作手冊和使用者手冊的區別:

操作手冊是系統級別的文件,而使用者手冊是需求級別的文件,一個針對操作,一個針對功能詳解,操作手冊是想得到什麼介面,如何操作,而使用者手冊,你要介紹為什麼要有這些操作,經過這些操作,得到的結果介面是幹什麼用的。如果說包含關係,使用者手冊是包括操作手冊的。

十二、《開發進度月報》

開發進度月報的編制目的是及時向有關管理部門彙報專案開發的進展和情況,以便及時發現或處理開發過程中出現的問題。一般開發進度月報是以專案組為單位每月編寫的。如果被開發的軟體系統規模比較大,整個工程專案被劃分給若干個分專案組承擔,開發進度月報將以專案組為單位按月編寫。

預期讀者為專案管理員。

總結:軟體開發文件都是有時間順序、操作流程順序聯絡的,編寫文件前首先要了解各文件的作用,有備無患。

11

相關推薦

軟體工程各類發文作用

內容提綱:(1)軟體工程各類開發文件的目的與作用詳解               (2)操作手冊與使用者手冊的區別。 一、《可行性研究報告》 可行性研究報告是在制定研發專案之前,以全面、系統的分析

軟體發文編寫規範

      對於軟體工程學科的同學都知道,軟體工程是一門技術含量高設計極其複雜的學科。為了控制好軟體產品質量和規範,就必須用大量的文件約束軟體工程的進度和狀態。浩大的軟體工程對於缺少工作和專案經驗的人來說,必然是摸不著頭腦不知從何開始。為了讓大家能夠快速適應標準的軟體開

Qt軟體發文16---軟體更新:寫入程式版本資訊並讀取程式的版本號

實現軟體更新,需要寫入本地軟體的版本號,並讀取出來,與伺服器版本號相比較,決定是否進行軟體的更新。 1.寫入版本資訊: 寫入一個rc檔案,並將其匯入到Qt工程中。  在Qt工程中,利用RC_FILE+=version.rc 匯入工程  QT+VS編譯時,利用cmake匯入

你會寫軟體發文嗎?

如今,軟體開發越來越複雜,軟體的功能也越來越豐富。而幾乎所有成熟的商業軟體,都是一個開發團隊齊心協力的血汗結晶。“羅馬不是一天建成的。”,當我們震撼於Microsoft Windows的驚世鉅著的同時,也道聽途說了一些微軟公司軟體工程是如何的完善和規範。軟體專案管理的成敗是

Just enough(剛剛好)的軟體發文什麼樣?

在今年與多個軟體開發單位的交流中,補文件的問題多次提到,試圖通過本文談談文件的價值,如何寫剛剛好的文件。 軟體開發所需要的文件在傳統的瀑布型生命週期下典型的有:開發計劃,需求規格說明書,設計書(有分成基本設計書、詳細設計書;也有分成High Level Design、Low Level Design;或者概

軟體發文分類以及和軟體生命週期的關係

前一段時間寫了初步學習了軟體開發文件,雖然耗時不斷感覺理解的並不是很深刻,最近我們舉行了一次學術交流會,讓我們重新認識了軟體開發文件。一開始總感覺總是對文件不怎麼感什麼興趣,枯燥、冗長、無聊,只是按

巴山鐵路工人吳磊自學在雲上發文簽報系統,把緊急通知及時送到鐵路工人手中,確保行車安全

時空 無法 target 傳輸 管理 財務 一段時間 所有 重要 從雪域高原來到秦巴山區,轉眼已是12年。這期間,吳磊守著兩條靜靜的鋼軌。 吳磊說,他不怕守,因為,“1999年,18歲應征入伍就是邊防戰士,只不過那個時候在日喀則,守的是國境,守的是國家安全,現

r.js壓縮打包(require + backbone)項目發文

找到 -h ase 換行 body build ini 依賴 需要 最近項目穩定了一點,之前一直沒空關註的開發文件壓縮打包問題也有時間來解決了 AMD模塊化開發中的代碼壓縮打包工具——r.js 環境搭建基於nodejs;用於AMD模塊化

改 Anaconda Jupyter Notebook 發文保存目錄

自己的 alt 文件 pre 路徑 快捷方式 修改 .py cond 1.打開cmd,輸入命令找到配置文件路徑 jupyter notebook --generate-config 2.打開 jupyter_notebook_config.py 修改配置 c.Note

微信小程式小遊戲發文,小遊戲快速上手教程

微信小遊戲快速上手教程 檔案結構 小遊戲只有以下兩個必要檔案: game.js 小遊戲主程式入口 game.json 配置檔案 執行環境 小遊戲的執行環境跟小程式類似,執行在 JavaScriptCore 中,

ECSHOP二次發文【檔案結構說明和資料庫表分析】

地址:https://www.cnblogs.com/nuanxin/p/8032743.html Ecshop檔案結構 ecshop檔案架構說明  /*  ECShop 2.5.1 的結構圖及各檔案相應功能介紹 ECShop2.5.1_Beta upload 的目

【netcore基礎】.Net core使用swagger自動生成發文

之前寫過一篇 .Net 版本的部落格 https://www.cnblogs.com/jhli/p/8317566.html   現在只不過用了 netcore 之後的版本,其實差不多 netcore版本的效果圖如下   可以線上填引數除錯,非常方便  

如果沒有發文,會是什麼樣子?

首先,普及一下看圖知識:如何進入連續看圖模式? 1.安裝360瀏覽器 2.滑鼠懸放在圖片上 接著,你就可以隨心所欲的 看圖了            ---------------- 正文  -------

3.04-甘特圖的發文

普加甘特圖(PlusGantt) V3.0 開發文件: http://www.plusgantt.com/gantt/doc/ 資源甘特圖使用者手冊2.0(中文版): https://wenku.baidu.com/view/6a24e9d6844769

極簡發文編寫(How-to)

緣起 大部分開發人員不喜歡寫文件。但是一個合格的可維護專案,必須要有足夠的文件,因此一個專案開發到一定階段後需要適當的編寫文件。專案的型別多種多樣,有許多專案屬於內部專案,例如一個內部的開發引擎,或者一個本身就是面向開發者的專案。 本文考慮的是這種面向開發者的專案文件編寫。通過本文,你將快速獲得如下技能:

微信小程式發文(4)

微信小程式網路API 發起請求 上傳、下載 Websocket 檔案 資料快取 微信小程式媒體API 圖片 錄音 音訊播放控制 音樂播放控制 背景音訊播放管理 wx.createAudioContext(audioId) 視訊 wx.createVideoContext(videoId)

Method for Discovering Network Topology中文翻譯【Z-Stack Home 1.2.0發文

1.Purpose 本文描述了在任何給定的網路測定網路技術的方法,使用Z-Stack的 ZDO(Zigbee Device Object)層的API。在繼續之前請先閱讀ZStack Developer’s Guide和ZStack API文件。 2.Method 使用ZDP_IE

基於最新友盟發文,整合友盟分享功能,賦demo

整合準備 獲取Appkey 快速整合 獲取SDK,頁面截圖: 下載後開啟 匯入jar和res 添加回調Activity 微信 在包名目錄下建立wxapi資料夾,新建一個名為WXEntryActivity的activity繼承WXCallbackActivity。 QQ QQ不需

Micro發文

token 設計,參考:https://www.cnblogs.com/beer/p/6029861.html access_toKen = md5 ('app_id' + 'app_srect' + '2019-1-1')user_toKen  引數簽名:signature = sha1( d

微信小程式發文(5)

微信小程式開放介面: 生物認證 getUpdateManager 拓展介面 createWorker 開啟/關閉除錯 微信小遊戲工具: 設定頁介面 專案頁卡介面 開發快捷鍵 開發工具除錯 命令列呼叫 HTTP 呼叫 微信小遊戲渲染API: 畫布物件Canvas Canvas(畫布物件