軟件工程-概要設計文檔

嘮嘮叨叨:最近在寫概要設計文檔,發現自己的水平還是一般般,總想著怎么寫,如何寫,實際文檔的目的是溝通交流,重點不是寫得多高大上,重點是是否把問題說明白了!

當需求文檔出來以后,就可以著手寫概要設計文檔了,概要設計目的是從全局的角度給出這個項目或系統應該做什么、怎么做,內容一般包括如下幾個部分:

簡介

  • 背景:簡單介紹下項目背景,如果是新產品/新功能,需要說明啟動項目的原因、背景、產品的定位、目標取舍、可預期的效果;如果是升級功能,說明升級原因、對現有系統有什么影響、可預期的效果;
  • 名詞解釋:對文檔中新的或不常見的名詞、概念或簡略語給出定義和解釋;
  • 功能需求:即這個項目要完成的需求功能;一般會有對應的MRD;
  • 非功能需求:除了硬性的功能需求之外,還有處理延遲、吞吐量等非功能性需求;
  • 系統運行環境:列出系統所需的軟硬件需求,包括操作系統、機器型號及配置要求,建議用表格列出,最好還有部署架構圖(也可以單獨出部署設計文檔,在此引用);

系統設計思路

針對項目的關鍵問題,給出多種設計思路,并對比各種思路的優缺點,最后給出,采用哪種思路,并在后面的概要設計中詳述。

概要設計

闡述系統的整體設計,一般會包括多個部分(沒部分負責一個模塊)

  • 系統對外接口:即對外暴露的接口,如果比較復雜,可以編寫單獨的接口設計文檔,并在此引用。
  • 架構圖和說明:把系統分解成若干個子系統或模塊,給出系統架構圖,并給出每個模塊完成的主要功能。
  • 流程圖和說明:通過流程圖說明,各個模塊之間是如何交互來實現系統功能的。

安全設計(可選)

運維設計(可選)

附錄(可選)

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,836評論 6 540
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,275評論 3 428
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,904評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,633評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,368評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,736評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,740評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,919評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,481評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,235評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,427評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,968評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,656評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,055評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,348評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,160評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,380評論 2 379

推薦閱讀更多精彩內容