關於設計文件模板

2021-04-13 07:33:07 字數 3121 閱讀 2201

概要

本文對為什麼需要設計文件模板進行了基本的論述,並提出了乙個基本的設計文件模板。

目錄

1.為什麼要設計文件模板__

12.設計文件模板內涵__

23.設計文件模板要素__

2參考__

21.為什麼要設計文件模板

可以說現在是軟體過程的年代,從重量級的cmm(i)、rup到輕量級的xp…。重量級的過程(cmm(i)、rup等)強調文件在軟體開發過程中的核心地位,而輕量級的過程(xp等)則強調以code為主、文件為次。可以看出它們都強調了文件的重要性。

1.

為什麼要有設計文件?

l 好的設計文件可以幫助開發者 「整理清楚個人的思路

l 好的設計文件可以幫助團隊「有效的交流溝通

2.

為什麼要有模板?

l 好的模板不是固化而是引導開發者的思路

l 好的模板可以提供文件的一致性、可讀性

因此,我們需要乙份設計文件模板來引導而非固化我們對問題的認識和思考,規範文件的書寫、提高文件的可讀性和一致性以及可重用性,進而來幫助我們進行有效的溝通。

2.設計文件模板內涵

如果乙個東西只流於形式,而沒有真正的內涵,那麼它的作用將微乎其微,而且日久就會被遺棄,設計文件模板也不例外。因此設計文件模板是應該有內涵的,應該體現人性,而不是去刻意以某種規則去固化人對問題的認識和思考。

下表列出了我對於設計文件模板內涵的一些理解:

編號

內涵

基本描述

1

歷史性

設計文件模板應該體現出文件的歷史,不但可以利於日後的維護,還可以依文尋人、避免重蹈覆轍等。

2

文學性

設計文件模板應該有一定的良好的組織方式來引導人的思路以及思考方式(既象**又象新聞)

3

藝術性

文設計檔模板應該有好的展現形式,來提高衍生出來的文件的美感

4

科學性

設計文件模板應該體現出軟體設計的基本的方**以及基本思想(如物件導向+敏捷)

3.設計文件模板要素

依據上面提到的設計文件模板的內涵,下面的**列出了乙個典型的(物件導向)設計文件模板的基本要素:

1.版本歷史

2.概要

3.目錄

4.術語&符號

5.參考

6.提出問題

7.分析問題

8.測試設計

9.邏輯設計

a)體系結構

b)處理邏輯

c)關鍵資料結構

10.物理設計

參考

1.

敏捷強調:「設計文件,這個不強調的,但是開發過程中能沒這個嗎?我看大多數嚴格的專案不能。做個比方,諸位參加過高考吧,設計文件就是考試時候的草稿紙,你的源**是考卷,一切以考卷上的內容為準。設計文件是可以扔掉的。有些神仙考試可以不用打草稿,有些牛人程式設計可以不寫文件,這是一回事情。編寫設計文件可以整理清楚個人的思路,風格一致的設計文件也方便團隊間的交流溝通,敏捷推崇面對面的交流,這是很好的,但有時候乙個圖形抵過一大堆廢話,有記錄也有利於設計的逐步推進,不然容易反覆。當然也有缺點,寫文件很花時間。設計文件寫到什麼程度,細到什麼層次,因團隊實際情況,人員的能力而異,一般來說,團隊成員間水平差別大就要多做些文件設計文件是不需要和**同步的,就像考卷不要和草稿紙同步一樣

。」

do agile methods require documentation?

2. 「和所有人類有目的的行為一樣,設計是一種藝術、是一種工程、是一種帶有臆測性的行為,也是一種實驗性的活動。」 3.

用來描繪源**的圖示只是設計的附屬物而不是設計本身「 4.

源**是設計最重要的表示「 5.

敏捷設計強調設計應當保持盡可能簡單、適當。它是乙個持續的應用(設計)原則模式以及實踐來改進軟體的結構和可讀性的過程。它致力於保持系統設計在任何時間都盡可能簡單乾淨以及富有表現力「 6.

**即文件(microsoft),建立在高度穩定的團隊基礎之上(這時,面對面的溝通強於文件本身)」 7.

除非是必須馬上撰寫文件而且意義重大,否則的話就乾脆不要寫它」 (martin) 參考

:on documentation

8. 「在敏捷方法中,設計文件往往是由測試優先方法指導編寫的單元測試所構成的。這些單元測試都是如何使用各部分**的鮮活的例子。其它種類的設計文件,像是類圖、互動圖、狀態圖、er圖等也可能會酌情使用

設計文件模板

架構設計說明書 架構設計重點在於將系統分層並產生層次內的模組 闡明模組之間的關係 一.概述 描述本文的參考依據 資料以及大概內容。二.目的 描述本文編寫的目的。三.架構設計 闡明進行架構設計的總體原則,如對問題域的分析方法。3.1.架構分析 對場景以及問題域進行分析,構成系統的架構級設計,闡明對於系...

DDD領域驅動設計 設計文件模板

系統背景和定位 業務需求描述 系統用例圖 關鍵業務流程圖 領域語言整理,主要是整理領域中的各種術語的定義,名詞解釋 領域劃分 分析出子域 核心域 支撐域 每個子域的領域模型設計 實體 值物件 聚合 領域事件,需要注意的是 領域模型是需要抽象的,要分析業務本質,而不是簡單的直接對需求進行建模 領域模型...

資料庫設計文件模板

文件名稱 文件用於說明資料庫設計 專案名稱 系統名稱 子系統名稱 密級 可以對外發布,公司內部所有人員,公司內部部門,專案組,指定人員 公司日期 作者 修改者 版本 修改原因 時間 目錄第 1 章 概述 3 1.1 分類 3 1.2 說明資料庫的分布特性 3 1.3 說明資料庫的備份要求 3 第 2...