天天看點

軟工文檔編寫總結

從看視訊之前,就知道最後需要完成的是編寫文檔。可是最後視訊看完後,對文檔的編寫一點頭緒都沒有。

在師父的英明指導下,這項工作終于不再是止步不前了。師父說,文檔最重要的就是:每份文檔應該在什麼階段編寫、由誰編寫、寫給誰看以及每份文檔其中包含什麼内容。

有了這個思路,文檔編寫輕松了許多。是以,自己就将軟體開發的生命周期與文檔編寫再次聯系起來,各個不同階段,就會相應地産生一份不同的文檔。

是以,在之前總結的基礎上,将需要産生的相應的文檔添加上去。下面便是每個生命周期與各個文檔的對應:

軟工文檔編寫總結

下面具體看各個文檔:

階段一:軟體開發的分析階段

軟工文檔編寫總結

本階段包含三個文檔,最初的可行性研究報告,就是對這項軟體開發工作的是否可行進行分析。一開始,需要對項目的各方面都有所了解,加之對現有系統情況的把握,确定如何做到一個全新系統的方案。另外,加上對經濟以及社會因素的考慮,最後得出該方案是否可行的結論。

對項目做完可行性研究後,可行的話,就需要開始總體規劃,這時期就需要一個項目開發計劃文檔。其中内容包括對項目的概述、實施計劃、支援條件等。

每款軟體的開發最後都是需要面向使用者的,是以對使用者的需求必須做到清楚了解和認識。相應地,産生軟體需求說明書,主要是綜合使用者各方面條件,對軟體的目标、運作環境都加以說明。

階段二:軟體開發的設計階段

軟工文檔編寫總結

本階段共包含7個文檔,從總體設計到最後的開發總結,每一個文檔都是關鍵的一步。隻有走好每一步,最後才有可能會更好。文檔的内容要點就不再加以說明了。

階段三:軟體開發的維護階段

軟工文檔編寫總結

本階段雖然隻需要編寫一個文檔,但工作任務還是繁重的。程式維護手冊,主要包括對系統的用途、安全等方面的一個說明和對裝置、軟體及資料庫方面操作環境的闡述,都是以便對程式更好地維護;其中每個維護過程也需要在文檔中記錄下來,包括約定、驗證、出錯及糾正方法。

除了軟體開發整個生命周期的三個階段,其實還需要編寫一些其他管理性質的文檔,如使用者手冊等。這可以算是後期的工作。除此之外,一個軟體開發項目可能曆時很久,是以就需要有個進度報告,進而有個看得見的文檔,對系統的每一步都做好規劃,因而保證開發工作能夠如期完成。

階段四:軟體開發其他文檔編寫

軟工文檔編寫總結

從頭至尾,共12篇文檔,它們的完成,才算是一個軟體開發項目真正完工。

對于這個階段的學習,自己最大的感受就是:思路決定出路。自己的思路有了,才可能會看到一條光明的出路。之是以最初不知道如何開始,就是沒有找到一條思路去做。在師父指導後,思路清晰了,後面的路也就順暢了很多。