中國項目管理資源網

您的位置:中國項目管理資源網 >> IT通信項目管理

軟件項目如何做好文檔管理?

2018/10/15 10:39:43 |  161次閱讀 |  來源:網友轉載   【已有0條評論】發表評論

 在經歷過許多實際的軟件研發項目,和多次的制定組織級軟件研發項目規范工作,對于軟件研發項目中的文檔管理有不少的體會,文檔管理是必不可少的內容,其必要性無人可以否認,但是,一套“規范”的文檔,也經常會讓人抓狂,“浪費”很多時間在文檔上面。在軟件項目的文檔管理中,如何使文檔管理更加有效,實際能夠折射出許多的管理理念。

  1、保證有效溝通

  文檔的主要作用是用于溝通,在所有的軟件規劃、設計、實現、運行、使用、服務等相關人員之間的信息交換。在文檔編寫過程中,要求所傳遞信息做到完整、準確、簡潔,特別是要能夠適合讀者理解。緊緊抓住信息溝通這一核心目的,對于無論是制作文檔模板還是編制具體文檔,都是很重要的指導思想。記得早年學習過國標的軟件工程文檔規范,不僅文檔很多,而且很多的文檔的第一章都是背景介紹,曾經試圖按照這種規范來編寫文檔,第一章寫了幾行就實在是寫不下去了,這確實會令許多的軟件開發人員感到抓狂,在今天更加強調響應速度的開發過程要求來說,幾乎是無法執行的。因此,在編寫文檔時,關鍵就抓住兩點:一時明確文檔的讀者對象,二是站在讀者角度把讀者希望了解的信息完整、準確、簡潔的描述清楚。寫文檔和讀文檔,就如同是作者與讀者之間在對話,把要傳遞的內容描述清楚,文檔的目的就達到了。啰里啰嗦的無關內容,不僅浪費作者和讀者的時間,也會影響對文檔重要信息的突出。

  2、與所采用的工程方法相匹配

  在軟件研發方面有許多不同的工程方法,瀑布式、原型法、敏捷開發等等,不同的開發過程實際意味著不同的生產工藝,那么在不同的工藝方法中各道工序的工作內容和要求不同、工序之間的銜接要求不同,必然也會對文檔的要求產生不同。因此,在編寫文檔時,也需要考慮開發項目中所采用的工程方法的因素,在單位制定軟件開發文檔模板時,也需要考慮不同的文檔體系,以支持不同的開發過程方法。

  3、經得住事后審計

  作為交付物的文檔,必須要能夠清晰記載各種事項的來龍去脈和因果關系,對于一些重要的決策要記錄其關鍵過程,也就是說,無論是從專業角度還是從管理角度,對于形成邏輯關系的關鍵內容都要形成文檔記錄,不僅便于后續環節的理解,更要能夠經得起事后的審計。所以,對于一些比較重要的技術類和管理類文檔,從事后審計的角度來審視文檔內容,確實也是一個很好的視角。在很多單位當中,一份邏輯嚴謹、經得起審計的文檔,越來越重要。

  4、區分文檔的記錄與整理

  很多很多的人對于文檔都很頭疼,需要花費很多“額外”的時間來編寫,但實際上我們看到,許多需要在文檔記載的實質內容其實并不缺少,在軟件研發的項目過程中,該討論、該溝通的內容實質并不少。對此稍作區分可以看出,問題出在“整理”文檔上。所以在實踐中,可以將文檔的形成分成兩個階段,一是在過程中形成的記錄,這些記錄可以是手畫的草圖拍成照片,可以是簡單的會議記錄,也可以是工具軟件本身生成的特殊格式的輸出文件,比如數據庫設計文檔、項目計劃文檔,這些專業工具形成的特殊格式的文件,其實比轉換成EXCEL或PDF文檔要好用,而且能夠真正在后續的執行中繼續發揮作用。能反映實質內容的這些記錄形式,其實也是文檔!在項目進程告一段落后,再對這些原始的記錄進行整理,去除冗余信息,形成更為規范、易讀的制式文檔。

  在信息管理當中有一個基本原則,就是要在產生信息的地方收集信息才是最有效的。將文檔的形成過程分成記錄和整理兩個階段,用各種最方便的形式首先進行記錄,這樣也是可以作為文檔滿足實際需要和各種質量

    項目經理勝任力免費測評PMQ上線啦!快來測測你排多少名吧~

    http://www.03068220.com/pmqhd/index.html

“項目管理生根計劃”
企業項目經理能力培養和落地發展方案下載>>

分享道


網站文章版權歸原作者所有,如有認為侵權請聯系我們,將于1個工作日內作出處理!
網友評論【 發表評論 0條 】
網友評論(共0 條評論)..
驗證碼: 點擊刷新

請您注意護互聯網安全的決定》及中華人民共和國其他各項有關法律法規或間接導致的民事或刑事法律責任
·您在中國項目管理資源網新聞評論發表的作品,中國項目管理資源網有權在網站內保留、轉載、引用或者刪除
·參與本評論即表明您已經閱讀并接受上述條款
时时彩开奖结果记录表