軟體開發過程文件如何寫作? 「文件 雞肋」?

2021-05-23 08:05:21 字數 963 閱讀 4654

「雞肋——食之無味,棄之可惜」,軟體開發過程文件遭遇了雞肋一樣的境遇。

目前敏捷軟體開發過程非常流行。相對於軟體開發過程文件,敏捷軟體開發過程更加重視可執行的程式。

關於軟體開發過程文件,兩個極端都是不可取的:一是嚴格要求過程文件,把過程文件作為開發過程的乙個必然輸出,而不考慮文件是否真正的起作用,即「過度文件」。二是完全放棄文件,不進行任何的記錄。「過度文件」偏離軟體開發的實質,會造**力的極大浪費;放棄文件則會丟失開發中的關鍵資訊,不利於產品後期的維護。

我們需要在上面兩者之間做乙個權衡。這裡可以引用「二八定律」:用20%的文件,記錄80%的內容。這樣用最小的投入,獲取最大的價值。

20%的文件要記錄那些東西?

1、產品需求描述。

毋容置疑,這是最重要的乙個資訊。關於產品需求描述,可以寫兩個文件,乙個是需求的整體描述;乙個是功能特徵表文件。功能特徵表對整體需求進行分解,便於後期跟蹤需求。

2、軟體架構描述,軟體實體作用及相互聯絡。

系統整體結構描述,包括系統包括多少實體,每個實體的作用,實體間的互動機制等。一般要配備圖形說明。

3、程式內部結構,邏輯模組,互動。

軟體實體內部邏輯模組的劃分,各個模組的作用,以及各個模組間的互動機制。

4、資料庫設計。

資料庫,表達,欄位的設計。

5、通訊協議。

軟體實體間互動訊息描述,比如,sip,xml等。

6、關鍵資料結構函式。

能夠反映軟體實體邏輯結構的關鍵資料結構定義,函式。

7、複雜問題解決方案。

對於複雜需求的解決,需要多個軟體實體,或者多個邏輯模組互動實現。這些方案非常值得記錄,可以方便後續產品的維護。

文件寫作時間可以靈活一些,可以在專案開發過程中進行,如果開發進度非常緊張,也可以開發完成後在補充文件。如果維護過程中,對產品進行了大的更改,要及時的重新整理文件,保持文件與程式的同步。

寫文件過程中,文件的內容要放在首位,不可以在美工,格式上浪費過多的時間。

日常積累 軟體開發過程需要的全部文件

軟體開發過程需要的全部文件 一 可行性研究報告.dot 說明該軟體開發專案的實現在技術上 經濟上和社會因素上的可行性,評述為了合理地達到開發目標可供選擇的各種可能實施方案,說明並論證所選定實施方案的理由。二 專案開發計畫.dot 為軟體專案實施方案制訂出具體計畫,應該包括各部分工作的負責人員 開發的...

軟體開發過程中各種文件的作用

在軟體專案開發過程中,應該按軟體開發要求撰寫十三類文件,文件編制要求具有針對性 精確性 清晰性 完整性 靈活性 可追溯性!需求階段 1 可行性分析報告 說明該軟體開發專案的實現在技術上 經濟上和社會因素上的可行性,評述為了合理地達到開發目標可供選擇的各種可能實施方案,說明並論證所選定實施方案的理由。...

軟體開發 如何寫軟體開發文件

3.程式設計實現 4.整合 5.測試 6.維護 依據什麼需求,開發出什麼 硬體開發平台 nvidia jetson tx2 工業相機 作業系統 ubuntu 16.04 開發平台 ros 程式語言 python c 系統包含 資料採集 演算法實現 結果輸出 在某某硬體平台上安裝某某作業系統,安裝ro...