由於工作和時間原因，已幾年沒在博客園寫文章了，首先對一直堅持寫博客的同學們點個贊，經常寫博客是一種好學習的好習慣。剛好今天周末對着幾年來工作中一些事情回憶和總結，希望通過博客做個記錄或者給有興趣的同學們分享點經驗。本人一路走來從一名初級開發、中級、高級到現在技術經理兼職項目經理，7年多的時間，從純技術到技術+項目管理一個轉型。一直都處於學習總結、學習總結、學習總結的過程（重要的事情說三遍）。不管是.NET技術、工程過程、項目管理都積累一些個人經驗。本文主要對文檔方面的個人總結。
背景和目的
文檔是軟件開發中重要的組成部分，特別在國內軟件開發氛圍，相關文檔的重要性很弱化。對於一些開發人員有時撰寫文檔變成一種壓力和負擔，或者覺得浪費時間。當初我也有過這種心理，后來覺得能編寫相關文檔是一種很牛叉的能力。當我經歷過后，現在覺得：
- 文檔是開發過程不可缺少的產物；
- 是梳理思維的一種方式；
- 是一種信息記載和傳遞給他人的方式（口頭溝通會久而久之會遺忘或者丟失）；
- 對於項目型團隊，文檔項目交付一部分內容（不管基於項目交付，還是用於開發過程的目的）；
所以寫此文章是為記錄個人的總結，通過編寫文章進一步將總結內容梳理，同時將個人經驗分享給有興趣的同學們。
撰寫方式總結
軟件開發過程或者信息工程建設過程中，都設計很多文檔，比如：技術設計方面、項目管理方面。這些文檔其中更多是一種應用文的寫作。就像我們讀書時期練習應用寫作一樣。原理是一樣。我們在編寫文檔前需要思考幾方面內容：
- 編寫的目的；
- 編寫的事物特征、屬性；
- 閱讀對象；
- 定義好文章章節
首先我們先說下”編寫的目的“，在我們動手編寫時都一樣思考下，為什么要寫？寫於干嘛？寫給誰看？通過三個反問思考后，編寫目的即可清晰出來。其次結合編寫目的對需要描述的事物了解和分析其特征、屬性等，抓住主要特征或者重要部分進行描述。再者，閱讀對象的不同可能使得你的用詞不同。最后結合上述分析對文章定大章節。具體每個章節的內容描述方式可以使用：舉例子、分類別、作比較、列數字、下定義、作詮釋、引用說明、打比方、摹狀貌、引資料、畫圖表等。語言描述是否精確，簡明而要，描述邏輯是否清晰等方面只能靠練習。接着我們說下軟件開發過程中可能涉及的相關文檔及文檔編寫的作用和目的。
一般軟件項目建設過程包括：項目啟動階段、需求階段、設計開發階段、測試階段、實施階段、項目驗收。實際包括兩個主要過程：軟件工程過程和軟件開發項目管理過程。
工程過程文檔
軟件工程過程文檔包括：用戶需求文檔、軟件需求規格說明文檔、概要設計文檔、詳細設計文檔、測試文檔、用戶使用說明文檔及一些技術規范文檔。
1、用戶需求文檔：通過需求采集、分析后，形成書面文檔與客戶進行確認，其目的主要為明確項目開發范圍，其中用戶需求包括：功能性需求和非功能性需求。編寫時站在一個系統用戶的角度描述系統。
2、軟件需求規格說明文檔：部分人不太理解“軟件需求規格說明文檔”和“用戶需求文檔”的區別，其實“軟件需求規格說明文檔”是基於“用戶需求文檔”的基礎上詳細描述用戶需求，比如：客戶提出需要管理人員的需求，希望可以新增、編輯和刪掉，那么用戶需求確認后，進一步就是細化需求，如何新增？新增成功提示啥？能否重復新增？新增必填內容是啥？，其實可以理解為定規格。此文檔編寫目的是細化需求，確保正確理解對用戶需求，並將需求傳遞給設計/開發/測試人員。
3、概要設計文檔：此文檔是一個系統設計的核心，編寫此文檔是系統設計師將系統整體設計方案通過書面描述傳遞設計方案。便於客戶、開發、測試人員理解系統設計的思路。是從整體性的描述整個系統。任何一個系統的建設都缺少不了系統整體性設計。
4、詳細設計文檔：是依據概要設計的方案，對系統細化模塊進行設計，詳細設計更多是為了提供給開發人員閱讀，是對系統功能文檔化描述，測試人員結合軟件規格需求和設計文檔編寫測試文檔。
5、測試文檔：一個系統測試啟動前，需要進行測試的設計，就是測試方案，基於測試方案進行細化形成測試用例，測試用例執行結果形成測試報告文檔。測試文檔主要用於保證系統的質量和指導測試工作的開展。
6、用戶使用文檔：通過描述系統功能和使用場景，形成一個指導用戶使用系統的文檔。
還有一些技術規范的文檔，比如：編碼規范、開發流程定義和系統外部調用接口規范等。每個軟件工程文檔都有着實際的作用，可根據項目情況和團隊成熟度裁剪使用。有一部分開發的朋友誤解了“敏捷開發管理”中，溝通優先於文檔的規則，應該是通過口頭討論交流，達成統一設計思路后，將核心的設計思路和要點通過文檔記錄，避免浪費時間，提高效率。
項目管理文檔
項目管理過程文檔包括：項目啟動文檔、項目計划、監控文檔、項目報告文檔、項目驗證文檔及實施過程中相關文書等。
1、項目啟動文檔：項目啟動時，相關項目經理任命書、項目啟動會PPT。主要是為了證明項目正式啟動，將相關信息傳遞給項目各方面。
2、項目計划文檔：包括項目實施計划、日常開發計划和各階段性計划，其中項目整體實施計划文檔是項目實施方向，為了讓項目各方認識到項目開展大致過程、
3、監控文檔：主要是項目日常開展中采集的信息記錄，比如開發效率、日常進度。
4、項目報告文檔：是項目開展中，階段性報告、相關會議紀要、項目驗證總結報告等，主要描述項目的情況。
項目管理文檔也是根據項目實際情況而定，不同類型的項目可能產出的管理文檔不同，目的都是服務於項目順利實施和驗收。其中CMMI提供了一套比較全的過程和文檔定義模板使用，但是必須根據實際情況選用，不可照搬。
個人對文檔重要性的總結
能把文檔寫好其實挺考究一個人的邏輯思維能力和語文功底，還好我們涉及寫的是說明文而已。因為很多搞軟件開發的同學，大多都是偏理科生，邏輯思維好，書面和口頭表達能力很一般，這方面可能變成職業發展的阻路石。我們可以看下，那些專家、教授或者領導都是站起來能說、坐下能寫，綜合能力很強。思維能力、溝通能力和書面表達能力是你能否邁向更高層次的基礎。文章所提及的相關文檔，我將會再后續的博客分享。
上述只是個人的見解，可能有不准確的地方，對這方面有興趣的同學，可以一起討論。