軟件工程文檔編寫總結





(一)背景

    在完成機房收費系統之后,自己親身經歷了軟件文檔的編寫工作,在第一次編寫驗收不過的情況下,自己從18號到26號完成了自己的第二次編寫工作。初次編寫,感覺自己還是有很多東西沒有了解,但是,自己的收獲還是頗多的!

(二)收獲

    軟件工程文檔的編寫是自己從編程業余愛好者向專業編程人士轉變的一個里程碑,具有重要的意義。按照國家軟件工程文檔標准,軟件工程文檔都包括《可行性研究報告》《項目開發計划》《軟件需求說明書》《概要設計說明書》《詳細設計說明書》《數據庫設計說明書》《數據要求說明書》《測試計划》《測試分析報告》《項目開發總結報告》《操作手冊》《用戶手冊》《開發進度月報》。其中,《可行性研究報告》旨在分析、研究系統開發的可能性和可行性,目的在於為系統的開發以及通過審查提供有力的數據信息;《項目開發計划》對項目的開發做了詳細的開發計划,目的是對系統的開發起到引導的作用,保證項目團隊按時保質地完成項目目標,便於項目團隊成員更好地了解項目情況,使項目工作開展的各個過程合理有序,在該文檔中,尤其要注意的是應當通過甘特圖來時刻顯示開發的進度;《軟件需求說明書》是為了描述軟件系統的各種需求,以便業務需求提出者與需求分析人員、開發人員、測試人員及其相關利益人對軟件的需求達成共識;《概要設計說明書》在總體上描述了系統的架構和各模塊之間的關系,便於知道系統后期的開發工作;《詳細設計說明書》則是詳細地明確系統每一個結構、類和接口,為后期的代碼實現和軟件測試做准備;《測試計划》是在系統完成后,對系統進行測試工作的准則,測試是系統開發過程中非常重要的一個環節,完美的測試可以是系統的性能得到很好地優化,測試計划中應該詳細介紹測試的用例,每一個功能和單元模塊的輸入、輸出效果;《測試分析報告》是軟件測試后的輸出文檔,記錄了測試的過程和結果,並對發現的問題和缺陷進行分析,為糾正軟件存在的問題提供依據,《測試分析報告》文檔的質量直接決定着測試活動的質量,所以說也是非常重要的一部分;最后就是《項目開發總結報告》,它對系統從開始到最后投入運行做了一個詳細的分析報告,深刻分析了系統開發過程中的所有經歷,是一筆非常寶貴的財富。

    最后,我想重點介紹一下《數據庫設計說明書》和《數據要求說明書》。數據對於一個完整的系統來說是很重要的,是系統實現一切功能的基礎。所以,《數據庫設計說明書》就顯得尤為重要,它方便了開發人員用於創建數據庫和對數據庫進行一系列的操作,提供了系統的數據存儲和處理過程,同時用圖形的方式展現出來,適當的減少冗余,能夠很好地提高系統的效率;《數據要求說明書》應對數據庫中涉及到的數據進行詳細說明,對系統中用到的靜態數據和動態數據進行詳細描述,並對輸入、輸出數據做初步的約定。總之,數據庫的文檔記錄是軟件工程文檔編寫中的重中之重。

    至於《用戶手冊》、《操作手冊》都是為了方便用戶以及開發人員查閱、翻看操作過程中比較詳細的問題的,它們使用戶能夠很好地運用和處理系統,提高了系統的親和力。


(三)認識

    1.凡事都要有認真負責的態度,就是由於自己敷衍了事的態度,導致自己第一次文檔驗收不過,同時也感謝自己有了二次編寫,使自己的印象更加深刻,理解更加透徹;

    2.編寫的文檔還有諸多的不足,各種圖形的運用還不夠好,一方面是由於自己學習的深度還不夠,另一方面也是由於自己沒有深刻去體會文檔的內涵;

    3.自己的路是要由自己來走的,沒有任何人可以替代,同時,不同的人看到的風景也不一樣的;


注意!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系我们删除。



 
粤ICP备14056181号  © 2014-2021 ITdaan.com