軟件項目文檔管理中折射出的管理理念

軟件項目文檔管理中折射出的管理理念

在軟件開發(fā)項目當中，文檔管理是必不可少的內(nèi)容，其必要性無人可以否認，但是，一套“規(guī)范”的文檔，也經(jīng)常會讓人抓狂，“浪費”很多時間在文檔上面。在經(jīng)歷過許多實際的軟件研發(fā)項目，和多次的制定組織級軟件研發(fā)項目規(guī)范工作，對于軟件研發(fā)項目中的文檔管理有不少的體會，在軟件項目的文檔管理中，如何使文檔管理更加有效，實際能夠折射出許多的管理理念。保證有效溝通文檔的主要作用是用于溝通，在所有的軟件規(guī)劃、設計、實現(xiàn)、運行、使用、服務等相關人員之間的信息交換。在文檔編寫過程中，要求所傳遞信息做到完整、準確、簡潔，特別是要能夠適合讀者理解。緊緊抓住信息溝通這一核心目的，對于無論是制作文檔模板還是編制具體文檔，都是很重要的指導思想。記得早年學習過國標的軟件工程文檔規(guī)范，不僅文檔很多，而且很多的文檔的第一章都是背景介紹，曾經(jīng)試圖按照這種規(guī)范來編寫文檔，第一章寫了幾行就實在是寫不下去了，這確實會令許多的軟件開發(fā)人員感到抓狂，在今天更加強調(diào)響應速度的開發(fā)過程要求來說，幾乎是無法執(zhí)行的。因此，在編寫文檔時，關鍵就抓住兩點：一時明確文檔的讀者對象，二是站在讀者角度把讀者希望了解的信息完整、準確、簡潔的描述清楚。寫文檔和讀文檔，就如同是作者與讀者之間在對話，把要傳遞的內(nèi)容描述清楚，文檔的目的就達到了。啰里啰嗦的無關內(nèi)容，不僅浪費作者和讀者的時間，也會影響對文檔重要信息的突出。與所采用的工程方法相匹配在軟件研發(fā)方面有許多不同的工程方法，瀑布式、原型法、敏捷開發(fā)等等，不同的開發(fā)過程實際意味著不同的生產(chǎn)工藝，那么在不同的工藝方法中各道工序的工作內(nèi)容和要求不同、工序之間的銜接要求不同，必然也會對文檔的要求產(chǎn)生不同。因此，在編寫文檔時，也需要考慮開發(fā)項目中所采用的工程方法的因素，在單位制定軟件開發(fā)文檔模板時，也需要考慮不同的文檔體系，以支持不同的開發(fā)過程方法。經(jīng)得住事后審計作為交付物的文檔，必須要能夠清晰記載各種事項的來龍去脈和因果關系，對于一些重要的決策要記錄其關鍵過程，也就是說，無論是從專業(yè)角度還是從管理角度，對于形成邏輯關系的關鍵內(nèi)容都要形成文檔記錄，不僅便于后續(xù)環(huán)節(jié)的理解，更要能夠經(jīng)得起事后的審計。所以，對于一些比較重要的技術類和管理類文檔，從事后審計的角度來審視文檔內(nèi)容，確實也是一個很好的視角。在很多單位當中，一份邏輯嚴謹、經(jīng)得起審計的文檔，越來越重要。區(qū)分文檔的記錄與整理很多很多的人對于文檔都很頭疼，需要花費很多“額外”的時間來編寫，但實際上我們看到，許多需要在文檔記載的實質(zhì)內(nèi)容其實并不缺少，在軟件研發(fā)的項目過程中，該討論、該溝通的內(nèi)容實質(zhì)并不少。對此稍作區(qū)分可以看出，問題出在“整理”文檔上。所以在實踐中，可以將文檔的形成分成兩個階段，一是在過程中形成的記錄，這些記錄可以是手畫的草圖拍成照片，可以是簡單的會議記錄，也可以是工具軟件本身生成的特殊格式的輸出文件，比如數(shù)據(jù)庫設計文檔、項目計劃文檔，這些專業(yè)工具形成的特殊格式的文件，其實比轉換成EXCEL或PDF文檔要好用，而且能夠真正在后續(xù)的執(zhí)行中繼續(xù)發(fā)揮作用。能反映實質(zhì)內(nèi)容的這些記錄形式，其實也是文檔!在項目進程告一段落后，再對這些原始的記錄進行整理，去除冗余信息，形成更為規(guī)范、易讀的制式文檔。在信息管理當中有一個基本原則，就是要在產(chǎn)生信息的地方收集信息才是最有效的。將文檔的形成過程分成記錄和整理兩個階段，用各種最方便的形式首先進行記錄，這樣也是可以作為文檔滿足實際需要和各種質(zhì)量體系的要求，以后再經(jīng)過整理形成可供后人查閱的文檔，不必非要在緊張的開發(fā)項目過程中進行文檔整理工作。區(qū)分項目文檔與產(chǎn)品文檔在文檔管理中，還經(jīng)常遇到項目文檔和產(chǎn)品文檔的問題。在軟件研發(fā)項目中，一個項目任務的完成，經(jīng)常需要多個軟件系統(tǒng)(產(chǎn)品)的共同配合，從而會形成項目與產(chǎn)品之間多對多的矩陣式管理關系，既要滿足項目管理的需要，又要滿足各系統(tǒng)的產(chǎn)品管理的需要。一般的經(jīng)驗是，將針對單個系統(tǒng)的軟件需求、設計、編碼、測試的文檔作為產(chǎn)品文檔，作為相應的軟件版本的配套文檔，反映軟件系統(tǒng)本身的變化過程，而將跨系統(tǒng)的業(yè)務需求、整體方案、聯(lián)調(diào)測試、聯(lián)合投產(chǎn)、項目管理等相關文檔作為項目文檔，作為與相應業(yè)務需求和項目的配套文檔。這方面可以具體參考之前的短文《軟件研發(fā)項目中業(yè)務需求與應用系統(tǒng)之間的矩陣化管理》。滿足產(chǎn)品生命周期管理的需要就產(chǎn)品文檔而言，有的文檔可以是增量式的，只說明某一個版本的具體情況，而有的文檔則需要是全量式的，需要隨著新版本的發(fā)布而不斷更新，保持與最新版本相一致，最典型的例子就是用戶手冊，通常都要隨著版本的更新不斷進行同步更新，對應舊版本的用戶手冊已經(jīng)沒有實用價值。另外像產(chǎn)品使用的FAQ這類文檔，也是需要不斷加以補充、更新，并且以全量版本的方式發(fā)布。同時，像系統(tǒng)技術架構、數(shù)據(jù)結構、發(fā)生變更的代碼等，這些其實也需要維護全量的最新版本，才能有效支持后續(xù)版本的設計開發(fā)的需要。因此在文檔管理中，也需要對文檔進一步細分，同時滿足