首先,軟工文檔,
軟工文檔,也就是計划,設計,描述,使用軟件的一些文件,它最大的特點就是固定不變,用來給不同的人和計算機來閱讀.在期間,文檔起到了橋梁的作用,看這張圖很形象:
在這里在看一下國家統一規定的13個文檔的相關知識.先看一下文檔的分類:
各個文檔的內容:
1,可行性研究報告：說明該軟件開發項目的實現在技術上、經濟上和社會因素上的可行性，評述為了合理地達到開發目標可供選擇的各種可能實施的方案，說明並論證所選定實施方案的理由。
2, 項目開發計划：為軟件項目實施方案制定出具體計划，應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬件及軟件資源等。項目開發計划應提供給管理部門，並作為開發階段評審的參考。
3,軟件需求說明書：也稱軟件規格說明書，其中對所開發軟件的功能、性能、用戶界面及運行環境等作出詳細的說明。它是用戶與開發人員雙方對軟件需求取得共同理解基礎上達成的協議，也是實施開發工作的基礎。
4,數據要求說明書：該說明書應給出數據邏輯描述和數據采集的各項要求，為生成和維護系統數據文卷作好准備。
5, 概要設計說明書：該說明書是概要設計階段的工作成果，它應說明功能分配、模塊划分、程序的總體結構、輸入輸出以及接口設計、運行設計、數據結構設計和出錯處理設計等，為詳細設計奠定基礎。
6, 詳細設計說明書：着重描述每一模塊是怎樣實現的，包括實現算法、邏輯流程等。
7,用戶手冊：本手冊詳細描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。
8,操作手冊：本手冊為操作人員提供該軟件各種運行情況的有關知識，特別是操作方法的具體細節。
9, 測試計划：為做好組裝測試和確認測試，需為如何組織測試制定實施計划。計划應包括測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差范圍等。
10,測試分析報告：測試工作完成以后，應提交測試計划執行情況的說明。對測試結果加以分析，並提出測試的結論意見。
11, 開發進度月報：該月報系軟件人員按月向管理部門提交的項目進展情況報告。報告應包括進度計划與實際執行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。
12, 項目開發總結報告：軟件項目開發完成以后，應與項目實施計划對照，總結實際執行的情況，如進度、成果、資源利用、成本和投入的人力。此外還需對開發工作作出評價，總結出經驗和教訓。
13,軟件維護修改建議:此是為后期維護修改做記錄報告用的.
上邊講述了,文檔分類以及基本作用,下邊我們看文檔在軟件生命周期的位置:
最后我們看看這些文檔的宏觀作用,即它們要完成的任務,用這張圖展示一下:
對於上邊的幾個簡單的字符,我給大家解釋一下:
1,"什么",即回答此做什么,哪些需求需要被滿足;
2,"何處"即回答從何處,即所開發的軟件在什么環境中實現以及所需信息從哪里來;
3,"何時"即回答何時干,即所開發工作的時間如何安排;
4,"誰" 即某些開發(或維護)工作打算由"誰來干?"·
5,"如何"即某些需求是怎么實現的;
6,"為何"即為什么要進行那些軟件開發或維護修改工作?
以上是軟工文檔的相關內容,下邊我們看看UML圖以文檔的關系:
首先UML圖和文檔不是一一對應的,除了幾個核心圖,例如用例圖,類圖,其它圖都是可以再任何文檔中出現的.下邊就按照開發流程簡單說一下:
在需求分析階段,主要是Use Case Diagram（用例圖）來填充，是面向系統分析人員，需求人員甚至是用戶； 在設計階段，即概要設計和詳細設計說明書中是UML圖的主要載體，他們可以以UML圖為主，比如類圖，交互圖，活動圖，狀態圖，順序圖等，面向分析人員和 編程人員；而在其它文檔中，就可以根基實際情況，實際需要，靈活應變，填充適當的UML圖。
綜上，為宏觀上軟工文檔和UML圖的關系，在寫以前，畫以前我覺的我們有必要清楚文檔的各種作用目標，以及UML圖以之對應文檔，還有和軟件開發過程之間的關系。簡單理解，不足之處，請大家提出！
轉載自：http://blog.csdn.net/liujiahan629629/article/details/8582054