軟件的可維護性設計范本

#論軟件的可維護性設計隨著軟件大型化，復雜化的發(fā)展，軟件維護所耗費的資源越來越多，軟件可維護性設計日益得到重視.我單位近幾年開發(fā)綜合業(yè)務ATM交換機，用戶對交換機的可維護性要求很高.我參加了該項目并負責軟件的維護性設計工作.根據(jù)當前工作中在維護性設計中的不足.通過在各個軟件開發(fā)階段注重軟件可維護性的應用，規(guī)范文檔，使用CASE工具管理軟件版本和成立軟件可維護性設計小組等方面，為軟件的可維護性設計提供了幫助，并最終開發(fā)出具有良好可維護性的交換機軟件.但是由于初次實施這方面的工作，大家思想上認識不夠，訐多操作不習慣，并且單位里不具備專用的測試軟件和其它CAEE工具，在一定程度上制約了軟件可維護性的實施.詠經(jīng)過一系列的需求分析、設計、編碼和測試之后，軟件正式交付用戶值用口至此，軟件變進入維護期.軟件維護的工作量特別大，隨著時間的推移，軟件維護對開發(fā)商帶來的成本壓力也越來越大口許多軟件開發(fā)商要把T微的工作量用在維護已有的軟件上，平均來說，大型軟件的維護成本是開發(fā)成本的4倍左右.因此，在開發(fā)軟件時，就應該考慮到可維護性問題,進行軟件的可維護性設計.2cx）2年底，我單位開始為某集團開發(fā)綜合業(yè)務ATM交換機.該交換機支持多種業(yè)務應用，包括話音、工F數(shù)據(jù)、圖像和視頻等；用戶可通過維護臺或期管對交換機進行配置和管理；由于特殊的應用，用戶對該交換機提出了很高的要求，并且提出要求產(chǎn)品交付使用之后，我單位要有很好的服務支持，鑒于將來要大批量生產(chǎn)交換機，軟件的可維護性設計被提上日程口我有幸參加了該項目，并負責軟件的維護性設計工作.在以前的課題中，也曾提到過要進行軟件的可維護性設計，但在真正實施過程中，還存在諸多問題，主要表現(xiàn)在：（1）在軟件開發(fā)過程中對可維護性設計考慮欠缺，導致軟件設計從根本上就怒視了可維護性的重要性.（2）軟件設計文檔不規(guī)范，內(nèi)容不一致.在維護階段出現(xiàn)問題，根據(jù)文檔不易得到有幫助的信息，難以定位錯誤的類型和根源口在本交換機軟件的設計過程中，我們通過注重軟件可維護性的開發(fā)過程，規(guī)范文檔，使田「^口T日皆用的姓而亦新出卷^姓司雉珀肚器；上小￡日至求■而;井疔的注的司雉如肚器件.黑一、注重可維護性的開發(fā)垣程在整個交換機軟件的開發(fā)過程中，從軟件易于理解、易于測試、易于修改的角度出發(fā)，提高軟件的可維護性口在需求分析階段，和用戶進行充分的交流和協(xié)商，對將來要改進的和可能要修改的部分進行明確.由于該交換機所涉及的業(yè)務種類廣泛，并且綜合了話音、工P和掰管等多種技術(shù)，任何一種技術(shù)實現(xiàn)的功能不完善或者擴展性不好，都不會讓用戶滿意.但是，另一方面，又著慮到用戶需求和功能需求并非容易獲取，所以通過和用戶定期交流，舉辦各種形式的討論等方式盡可能了解當前的需求和以后需要擴展的需求信息，由專人整理記錄這些信息，作為以后的跟蹤內(nèi)容口即使在其它設計階段對需求的臨時變動，也要在這個記錄中體■現(xiàn)口在設計階段，交換機軟件被劃分為不同模塊進行設計，并遵睛“高內(nèi)聚、低耦合”的設計原則；這些工作便于將來軟件維護工作的進行.同時也已考慮到，對可能要擴展的地方，預留出充足接口口在一些模塊中，如網(wǎng)管模塊中，根據(jù)功能，盡可能使用面向?qū)５脑O計方法，以便維護時的修改和升級.在編碼階段，我和小組成員制定了統(tǒng)一的編碼規(guī)范，經(jīng)過半天的培訓，強化編碼人員對注釋的使用，并強調(diào)要保證注釋的質(zhì)量，對有可能出現(xiàn)誤解的地方，注釋的要詳細.并且，每個文件都要注明編寫者，生產(chǎn)日期和版本號.在測試階段，測試組成員已經(jīng)負責進行測試，我們小組這時的工作是根據(jù)測試報告，對照測試大綱和用例設計，對當前的測試進行總結(jié)，比如，何種測試用例發(fā)現(xiàn)何種錯誤，最常見的錯誤，如何從測試結(jié)果判斷是哪種錯誤，該錯誤所在的模塊是什么.在相關(guān)人員修改錯誤時，記錄排錯時的思路和過程.特別是，根據(jù)這些總結(jié)，我們編寫了*AM交換機軟件故障解析’1這篇總結(jié)在后來的維護階段被證明是最受歡迎的文檔之一.在維護階段，制定嚴格的管理要求.每一次維護工作之后，都要按照配置關(guān)聯(lián)，同步更新維護有關(guān)的系統(tǒng)文檔和用戶文檔，包括維護需求、源代碼、注釋、設計文檔、測試文檔和用戶便用手冊等，保證系統(tǒng)的一致性.維護中所進行的修改要專大記錄，生成“A1TI交換機維護更新”文檔，做為內(nèi)部文件存檔.同時把一些內(nèi)容擴充到交換機軟件故障解析”中.在用戶使用時，做好用戶的培訓工作，初期由專人和用戶一起操作交換機，直到能熟練操作，以免用戶便用交換機時產(chǎn)生不滿.二規(guī)范文檔交換機交付用戶使用之后，除了在培訓時所了解的內(nèi)容之外，為了讓用戶對交換機軟件能皤更好的理解和便用，向用戶提供了多種隨機文檔，包括功能說明，安裝文檔，用戶便用手冊，參考手冊，管理員指南等口在文檔的編寫過程之前，我們編寫了“A1TT交換機軟件文檔編寫規(guī)范巴時文檔格式和一些必要內(nèi)容進行了規(guī)范，保證各文檔的風格一致，內(nèi)容一致.對于一些用戶使用中容易出錯的地方，比如配置某種功能時，在用戶使用手冊示例說明口在具體編寫文檔時，根據(jù)設計人員的反饋信息，也及時調(diào)整了文檔編寫規(guī)范.在設計開發(fā)過程中，對某個問題進行修改，或者功能增刪，要充分考慮到問題所涉及的不同文檔，保證前后文檔在該問題的一致性.對于所修改的部分，要埴寫"更改單3需要寫明更改大，更改理由，更改所哥響的程序和文檔，更改日期，批準人.采用CAGE工具在這一方面也起到了事半功倍的作用.三、使用CASE工具管1軟件版本在軟件的設計編碼過程中，尤其是在調(diào)試階段，會不斷的生成新的程序版本.為了有效的管理版本問題，采用Raticm公司的ClearCaME工具，由專人負責進行管理，從而保證軟件版本的一致性口四、成立軟件可維護性設計d組為了有效的對軟件可維護性設計進行管理，成立了軟件可維護性設計小組.我擔任小組組長，明確了維護性設計的工作內(nèi)容和各大的責任，針對不同的模塊，又確定四個責任人.在運作過程中，組長對軟件開發(fā)階段所需進行的工作進行協(xié)調(diào)，備負責人對維護性設計所涉及的變動控制進行維護.因為交換機軟件的各個模塊開發(fā)時間有穿插，因此，對開發(fā)過程中出現(xiàn)的一些問題，包括技術(shù)方面和管理方面的問題，我們都及時進行了記錄，對后面開發(fā)的軟件模塊進行指導，避免了同樣問題的再次發(fā)生口現(xiàn)在這份文檔已經(jīng)成為單位新課題啟動時的“必段文檔口按照上面的思路，經(jīng)過兩年多的工作，我們已完成了交換機軟件的開發(fā)，新的軟件運行良好，交付用戶后，用戶很滿意，受到了業(yè)務部門和技術(shù)部門高層的贊許口尤其是我們所總結(jié)的晨口!交換機軟件故障解析”和“審交換機軟件文檔編寫規(guī)范”等文檔，對單位其它課題也起到了很好的指導和規(guī)范作用口并且，在提高軟件可維護性的同時，也提高了軟件產(chǎn)品的質(zhì)量，我自己的開發(fā)管理水平也得到了很大的提升.單位的高層領導對我們制定的規(guī)范和做法也表示認可，正式在其它課題中推廣.然而，由于初次在整個軟件開發(fā)過程中進行可維護性設計，還有訐多要改進的地方.訐多情況下，現(xiàn)有的可維護性設計措施理論性太強，具體實施時可參考的依據(jù)少，比如我們測試小組如何更好的與各課題開發(fā)組間進行協(xié)調(diào)工作，感覺還是有