『壹』 如何學習寫程序設計文檔
寫程序設計文檔,要注意簡潔和邏輯性,需要明確的是:文檔並不是進行設計的目標,也不是設計過程中額外的工作。具體模塊和步驟為:
1.需求分析
需求分析的結果通常需要使用需求說明文檔來描述,目前主流的需求描述方法包括:用戶例圖、用戶故事等方式。這些方式有所不同的側重,其核心思想就是描述清楚用戶的使用場景。
2.功能設計
對於主要是用戶界面的軟體項目來說,功能設計可以看作是畫出原型界面,描述使用場景,獲得用戶認可的過程。而對於沒有界面的軟體項目來說,則功能設計與需求分析的區分更為模糊。
3.系統架構設計
系統架構設計是一個非常依賴於經驗的設計過程。需要根據軟體項目的特定功能需求和非功能性需求進行取捨,最終獲得一個滿足各方要求的系統架構。系統架構的不同,將很大程度上決定系統開發和維護是否能夠較為容易的適應需求變化,以及適應業務規模擴張。
4.模塊/子系統概要設計
模塊/子系統的概要設計,由架構師參與,核心設計和開發人員負責的方式進行。
在概要設計工作中,需要在架構確定的開發路線的指導下,完成模塊功能實現的關鍵設計工作。在概要設計階段,需要關注於模塊的核心功能和難點進行設計。
5.模塊詳細設計
在瀑布式開發模型中,模塊的詳細設計會要求比較嚴格,將所有類進行詳細設計。除了一些對於系統健壯性要求非常嚴格的軟體項目,如國防項目,金融項目還要求有詳細設計文檔之外。其他的項目大多採用其他方式來處理這樣的工作,如自動化測試等。
綜上所述,軟體設計文檔作為軟體開發團隊的溝通、理解、知識共享的手段,具有非常重要的意義。