(1)什麼是文件
文件(document)是指某種資料**和其中所記錄的資料。它具有永久性,並可以由人或機器閱讀,通常僅用於描述人工可讀的東西。在軟體工程中,文件常常用來表示對活動、需求、過程或結果進行描述、定義、規定、報告或認證的任何書面或圖示的資訊。它們描述和規定了軟
件設計和實現的細節,說明使用軟體的操作命令。文件也是軟體產品的一部分,沒有文件的軟體就不成其為軟體。軟體文件的編制(documentation)在軟體開發工作中占有突出的地位和相當大的工作量。高質量、高效率地開發、分發、管理和維護文件對於轉讓、變更、修正、擴充和使用文件,對於充分發揮軟體產品的效益有著重要的意義。
然而,在實際工作中,文件在編制和使用中存在著許多問題,有待於解決。軟體開發人員中較普遍地存在著對編制文件不感興趣的現象。從使用者方面來看,他們又常常抱怨:文件售價太高、文件不夠完整、文件編寫得不好、文件已經陳舊或是文件太多,難於使用等等。究竟應當怎樣要求它,文件應當寫哪些內容,說明什~.inni,起什麼作用?這裡將給予簡要的介紹。
(2)軟體文件的作用
在軟體的生產過程中,總是伴隨著大量的資訊要記錄、要使用。因此,軟體文件在產品的開發生產過程中起著重要的作用。
1)提高軟體開發過程的能見度。把開發過程中發生的事件以某種可閱讀的形式記錄在文件中。管理人員可把這些記載下來的材料作為檢查軟體開發進度和開發質量的依據,實現對軟體開發的工程管理。
2)提高開發效率。軟體文件的編制,使得開發人員對各個階段的工作都進行周密思考、全盤權衡、從而減少返工。並且可在開發早期發現錯誤和不一致性,便於及時加以糾正。
3)作為開發人員在一定階段的工作成果和結束標誌。
4)記錄開發過程中的有關資訊,便於協調以後的軟體、開發、使用和維護。
5)提供對軟體的執行、維護和培訓的有關資訊,便於管理人員、開發人員、操作人員、使用者之間的協作、交流和了解。使軟體開發活動更科學、更有成效。
6)便於潛在使用者了解軟體的功能、效能等各項指標,為他們選購符合自己需要的軟體提供依據。
文件在各類人員、計算機之間的多種橋梁作用中看出:
既然軟體已經從手工藝人的開發方式發展到工業化的生產方式,文件在開發過程中就起到關鍵作用。從某種意義上來說,文件是軟體開發
規範的體現和指南。按規範要求生成一整套文件的過程,就是按照軟體開發規範完成乙個軟體開發的過程。所以,在使用工程化的原理和方法來指導軟體的開發和維護時,應當充分注意軟體文件的編制和管理。
(3)文件的分類
軟體文件從形式上來看,大致可分為兩類:
一類是開發過程中填寫的各種圖表,可稱之為工作**;另一類是應編制的技術資料或技術管理資料,可稱之為文件或檔案。
軟體文件的編制,可以用自然語言,特別設計的形式語言,介於兩者之間的半形式語言(結構化語言),各類圖形表示。**來編制文件。文件可以書寫,也可以在計算機支援系統中產生,但它必須是可閱讀的。
按照文件產生和使用的範圍,軟體文件大致可分為三類:
1)開發文件:這類文件是在軟體開發過程中,作為軟體開發人員前一階段工作成果的體現和後一階段工作依據的文件。包括軟體需求說明書、資料要求說明書、概要設計說明書、詳細設計說明書、可行性研究報告、專案開發計畫。
2)管理文件:這類文件是在軟體開發過程中,由軟體開發人員制定的需提交人員的一砦工作計畫或工作報告。使管理人員能夠通過這些文件了解軟體開發專案安排、進度、資源使用和成果等。包括專案開發計畫、測試計畫、測試報告、開發進度月報及專案開發總結。
3)使用者文件:這類文件是軟體開發人員為使用者準備的有關該軟體使用、操作、維護的資料。包括使用者手冊、操作手冊、維護修改建議、軟體需求說明書。
(4)[page]軟體文件的工作
國家標準局在2023年1月發布了《計算機軟體開發規範》和《軟體產晶開發檔案編制指南》,作為軟體開發人員工作的準則和規程。它們基於軟體生存期方法,把軟體產品從形成概念開始,經過開發、使用和不斷增補修訂,直到最後被淘汰的整個過程應提交的文件歸於以下十三種。下面對其中每乙個文件做一些簡要的說明:
1)可行性研究報告:說明該軟體專案的實現在技術上、經濟上和社會因素上的可行性,評述為合理地達到開發目標可供選擇的各種可能的實現方案,說明並論證所選定實施方案的理由。
2)專案開發計畫:為軟體專案實施方案制定出的具體計畫。它應包括各部分工作的負責人員、開發的進度、開發經費的概算、所需的硬體和軟體資源等。專案開發計畫應提供給管理部門,並作為開發階段評審的基礎。
3)軟體需求說明書:也稱軟體規格說明書。其中對所開發軟體的功能、效能、使用者介面機執行環境等作出詳細的說明。它是使用者與開發人員雙方對軟體需求取得共同理解基礎上達成的協議,也是實施開發工作的基礎。
4)資料要求說明書:該說明書應當給出資料邏輯描述和資料採集的各項要求,為生成和維護系統的資料檔案做好準備。
5)概要設計說明書:該說明書是概要設計工作階段的成果。它應當說明系統的功能分配、模組劃分、程式的總體結構、輸入輸出及介面設計、執行設計、資料結構設計和出錯處理設計等,為詳細設計奠定基礎。
6)詳細設計說明書:著重描述每乙個模組是如何實現的,包括實現演算法、邏輯流程等。
7)使用者手冊:詳細描述軟體的功能、效能和使用者介面,使使用者了解如何使用該軟體。
文件的作用和分類
軟體文件 document 也稱檔案,通常指的是一些記錄的資料 和資料 它具有固定不變的形式,可被人和計算機閱讀。它和 電腦程式共同構成了能完成特定功能的計算機軟體 有人把源 程式也當作文件的一部分 我們知道,硬體產品和產品資料在整 個生產過程中都是有形可見的,軟體生產則有很大不同,文件本 身就是軟...
文件的作用和分類
文件的作用和分類 軟體文件 document 也稱檔案,通常指的是一些記錄的資料 和資料 它具有固定不變的形式,可被人和計算機閱讀。它和 電腦程式共同構成了能完成特定功能的計算機軟體 有人把源 程式也當作文件的一部分 我們知道,硬體產品和產品資料在整 個生產過程中都是有形可見的,軟體生產則有很大不同...
文件的作用和分類
自標準化資訊網 2003年04月21日 軟體文件 document 也稱檔案,通常指的是一些記錄的資料 和資料 它具有固定不變的形式,可被人和計算機閱讀。它和 電腦程式共同構成了能完成特定功能的計算機軟體 有人把源 程式也當作文件的一部分 我們知道,硬體產品和產品資料在整 個生產過程中都是有形可見的...