軟件工程-概要設(shè)計文檔

嘮嘮叨叨:最近在寫概要設(shè)計文檔,發(fā)現(xiàn)自己的水平還是一般般躏鱼,總想著怎么寫娩嚼,如何寫庶灿,實際文檔的目的是溝通交流,重點不是寫得多高大上窄做,重點是是否把問題說明白了愧驱!

當(dāng)需求文檔出來以后,就可以著手寫概要設(shè)計文檔了椭盏,概要設(shè)計目的是從全局的角度給出這個項目或系統(tǒng)應(yīng)該做什么组砚、怎么做,內(nèi)容一般包括如下幾個部分:

簡介

  • 背景:簡單介紹下項目背景掏颊,如果是新產(chǎn)品/新功能糟红,需要說明啟動項目的原因、背景乌叶、產(chǎn)品的定位改化、目標(biāo)取舍、可預(yù)期的效果枉昏;如果是升級功能,說明升級原因揍鸟、對現(xiàn)有系統(tǒng)有什么影響兄裂、可預(yù)期的效果句旱;
  • 名詞解釋:對文檔中新的或不常見的名詞、概念或簡略語給出定義和解釋晰奖;
  • 功能需求:即這個項目要完成的需求功能谈撒;一般會有對應(yīng)的MRD;
  • 非功能需求:除了硬性的功能需求之外匾南,還有處理延遲啃匿、吞吐量等非功能性需求;
  • 系統(tǒng)運行環(huán)境:列出系統(tǒng)所需的軟硬件需求蛆楞,包括操作系統(tǒng)溯乒、機器型號及配置要求,建議用表格列出豹爹,最好還有部署架構(gòu)圖(也可以單獨出部署設(shè)計文檔裆悄,在此引用);

系統(tǒng)設(shè)計思路

針對項目的關(guān)鍵問題臂聋,給出多種設(shè)計思路光稼,并對比各種思路的優(yōu)缺點,最后給出孩等,采用哪種思路艾君,并在后面的概要設(shè)計中詳述。

概要設(shè)計

闡述系統(tǒng)的整體設(shè)計肄方,一般會包括多個部分(沒部分負(fù)責(zé)一個模塊)

  • 系統(tǒng)對外接口:即對外暴露的接口冰垄,如果比較復(fù)雜,可以編寫單獨的接口設(shè)計文檔扒秸,并在此引用播演。
  • 架構(gòu)圖和說明:把系統(tǒng)分解成若干個子系統(tǒng)或模塊,給出系統(tǒng)架構(gòu)圖伴奥,并給出每個模塊完成的主要功能写烤。
  • 流程圖和說明:通過流程圖說明,各個模塊之間是如何交互來實現(xiàn)系統(tǒng)功能的拾徙。

安全設(shè)計(可選)

運維設(shè)計(可選)

附錄(可選)

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末洲炊,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子尼啡,更是在濱河造成了極大的恐慌暂衡,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,427評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件崖瞭,死亡現(xiàn)場離奇詭異狂巢,居然都是意外死亡,警方通過查閱死者的電腦和手機书聚,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,551評論 3 395
  • 文/潘曉璐 我一進店門唧领,熙熙樓的掌柜王于貴愁眉苦臉地迎上來藻雌,“玉大人,你說我怎么就攤上這事斩个】韬迹” “怎么了?”我有些...
    開封第一講書人閱讀 165,747評論 0 356
  • 文/不壞的土叔 我叫張陵受啥,是天一觀的道長做个。 經(jīng)常有香客問我,道長滚局,這世上最難降的妖魔是什么居暖? 我笑而不...
    開封第一講書人閱讀 58,939評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮核畴,結(jié)果婚禮上膝但,老公的妹妹穿的比我還像新娘。我一直安慰自己谤草,他們只是感情好跟束,可當(dāng)我...
    茶點故事閱讀 67,955評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著丑孩,像睡著了一般冀宴。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上温学,一...
    開封第一講書人閱讀 51,737評論 1 305
  • 那天略贮,我揣著相機與錄音,去河邊找鬼仗岖。 笑死逃延,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的轧拄。 我是一名探鬼主播揽祥,決...
    沈念sama閱讀 40,448評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼檩电!你這毒婦竟也來了拄丰?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,352評論 0 276
  • 序言:老撾萬榮一對情侶失蹤俐末,失蹤者是張志新(化名)和其女友劉穎料按,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體卓箫,經(jīng)...
    沈念sama閱讀 45,834評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡载矿,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,992評論 3 338
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了烹卒。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片恢准。...
    茶點故事閱讀 40,133評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡魂挂,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出馁筐,到底是詐尸還是另有隱情,我是刑警寧澤坠非,帶...
    沈念sama閱讀 35,815評論 5 346
  • 正文 年R本政府宣布敏沉,位于F島的核電站,受9級特大地震影響炎码,放射性物質(zhì)發(fā)生泄漏盟迟。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,477評論 3 331
  • 文/蒙蒙 一潦闲、第九天 我趴在偏房一處隱蔽的房頂上張望攒菠。 院中可真熱鬧,春花似錦歉闰、人聲如沸辖众。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,022評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽凹炸。三九已至,卻和暖如春昼弟,著一層夾襖步出監(jiān)牢的瞬間啤它,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,147評論 1 272
  • 我被黑心中介騙來泰國打工舱痘, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留变骡,地道東北人。 一個月前我還...
    沈念sama閱讀 48,398評論 3 373
  • 正文 我出身青樓芭逝,卻偏偏與公主長得像塌碌,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子铝耻,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,077評論 2 355

推薦閱讀更多精彩內(nèi)容