詳細(xì)設(shè)計(jì)書(shū)編寫(xiě)規(guī)范模板(初步設(shè)計(jì)文本編制規(guī)范)
本篇文章給大家談?wù)勗敿?xì)設(shè)計(jì)書(shū)編寫(xiě)規(guī)范模板,以及初步設(shè)計(jì)文本編制規(guī)范對(duì)應(yīng)的知識(shí)點(diǎn),希望對(duì)各位有所幫助,不要忘了收藏本站喔。
本文目錄一覽:
- 1、設(shè)計(jì)說(shuō)明書(shū)格式是怎樣的?
- 2、設(shè)計(jì)說(shuō)明書(shū)怎么寫(xiě),應(yīng)該注意什么?正確格式?
- 3、如何寫(xiě)詳細(xì)設(shè)計(jì)文檔
設(shè)計(jì)說(shuō)明書(shū)格式是怎樣的?
課程設(shè)計(jì)說(shuō)明書(shū)撰寫(xiě)格式
為了保證課程設(shè)計(jì)質(zhì)量,特制定本規(guī)范。
設(shè)計(jì)說(shuō)明書(shū)要求按統(tǒng)一格式打印,其版面要求:A4紙,頁(yè)邊距:上2cm,下
2cm,左
2.5cm、右
2cm;字體:正文宋體、小四號(hào);行距:固定值
20;頁(yè)碼:底部居中。
一份完整的設(shè)計(jì)說(shuō)明書(shū)應(yīng)包括以下幾個(gè)方面:一、封面(包括題目、院系、學(xué)生班級(jí)、設(shè)計(jì)組號(hào)、學(xué)生組員姓名、指導(dǎo)
教師姓名等)(見(jiàn)附
1)。
二、目錄
居中打印目錄二字,(四號(hào)黑體,段后
1
行),字間空一字符;章、節(jié)、小
節(jié)及其開(kāi)始頁(yè)碼(字體均為小四號(hào)宋體)。節(jié)向右縮進(jìn)兩個(gè)字符,小節(jié)及以后標(biāo)
題均向右縮進(jìn)四個(gè)字符。目錄中應(yīng)包含正文及其后面部分的條目。目錄的最后一
項(xiàng)是無(wú)序號(hào)的“參考文獻(xiàn)資料”.
三、正文
(一)正文內(nèi)容一般應(yīng)包括:1、設(shè)計(jì)任務(wù)和要求:說(shuō)明本課題應(yīng)解決的主要問(wèn)題及應(yīng)達(dá)到的技術(shù)要求;
簡(jiǎn)述本設(shè)計(jì)的指導(dǎo)思想。
2、設(shè)計(jì)依據(jù)和設(shè)計(jì)原則。
3、方案論證:闡明為什么要選擇這個(gè)設(shè)計(jì)方案以及所采用方案的特點(diǎn)。
4、設(shè)計(jì)論述:對(duì)設(shè)計(jì)工作的詳細(xì)表述(包括設(shè)計(jì)計(jì)算)。要求層次分明、表
達(dá)確切。
5、結(jié)論或總結(jié):對(duì)整個(gè)設(shè)計(jì)工作進(jìn)行歸納和綜合。
(二)正文要求:(1)計(jì)算正確,論述清楚,文字簡(jiǎn)練通順,插圖簡(jiǎn)明,書(shū)寫(xiě)整潔。文中圖、表按制圖要求繪制。
(2)
段落及層次要求:每節(jié)標(biāo)題以四號(hào)黑體左起打印
(段前段后各0.5行),
節(jié)下為小節(jié),以小四號(hào)黑體左起打?。ǘ吻岸魏蟾?/p>
0.5
行)。換行后以小四號(hào)宋
體打印正文。節(jié)、小節(jié)分別以1、1.1、1.1.1依次標(biāo)出,空一字符后接各部分的標(biāo)題。
當(dāng)論文結(jié)構(gòu)復(fù)雜,
小節(jié)以下的標(biāo)題,
左起頂格書(shū)寫(xiě),
編號(hào)依次用
(1)、(2)
……
或
1)、2)……順序表示。字體為小四號(hào)宋體。
對(duì)條文內(nèi)容采用分行并敘時(shí),其編號(hào)用(a)、(b)……或
a)、b)……
順序表示,如果編號(hào)及其后內(nèi)容新起一個(gè)段落,則編號(hào)前空兩個(gè)中文字符。
(3)圖紙要求:圖面整潔,布局合理,線(xiàn)條粗細(xì)均勻,圓弧連接光滑,尺
寸標(biāo)注規(guī)范,使用計(jì)算機(jī)繪圖。
(4)曲線(xiàn)圖表要求:所有曲線(xiàn)、圖表、線(xiàn)路圖、流程圖、程序框圖、示意
圖等不準(zhǔn)徒手畫(huà),必須按國(guó)家規(guī)定標(biāo)準(zhǔn)或工程要求繪制(采用計(jì)算機(jī)輔助繪圖)。
(5)課程設(shè)計(jì)說(shuō)明書(shū)(報(bào)告)中圖表、公式要求如下:(a)圖:圖的名稱(chēng)采用中文,中文字體為五號(hào)宋體,圖名在圖片下面。引
用圖應(yīng)在圖題右上角標(biāo)出文獻(xiàn)來(lái)源。圖號(hào)以章為單位順序編號(hào)。格式為:圖1-1,
空一字符后,接圖名。
(b)表格:表的名稱(chēng)及表內(nèi)文字采用中文,中文字體為五號(hào)宋體,表名在
表格上面。
表號(hào)以章為單位順序編號(hào),
表內(nèi)必須按規(guī)定的符號(hào)標(biāo)注單位。
格式為:表
1-1,空一字符后,接表格名稱(chēng)。
(c)公式:公式書(shū)寫(xiě)應(yīng)在文中另起一行,居中排列。公式序號(hào)按章順序編
號(hào)。字體為五號(hào)宋體,序號(hào)靠頁(yè)面右側(cè)。格式為:(1-1)……
四、設(shè)計(jì)體會(huì)及今后的改進(jìn)意見(jiàn)
五、參考文獻(xiàn)(資料)
參考文獻(xiàn):另起一頁(yè),
居中打印參考文獻(xiàn)四字
(四號(hào)黑體,
段前段后1行),
字間空一字符;另起一行,按論文中參考文獻(xiàn)出現(xiàn)的先后順序用阿拉伯?dāng)?shù)字連續(xù)
編號(hào)(參考文獻(xiàn)應(yīng)在正文中注出);參考文獻(xiàn)中每條項(xiàng)目應(yīng)齊全(字體均為小四
號(hào)宋體)。(格式:[編號(hào)]作者。論文或著作名稱(chēng)。期刊名或出版社。出版時(shí)間)。
(期刊應(yīng)注明第幾期、起止頁(yè)數(shù)(包括論著))。
六、課程設(shè)計(jì)資料的裝訂
課程設(shè)計(jì)說(shuō)明書(shū)按以下順序裝訂成冊(cè):封面、目錄、正文、設(shè)計(jì)體會(huì)及今
后的改進(jìn)意見(jiàn)、參考文獻(xiàn);設(shè)計(jì)任務(wù)書(shū)、設(shè)計(jì)說(shuō)明書(shū)(報(bào)告)和圖紙等裝入課程
設(shè)計(jì)專(zhuān)用袋中。
附
1
課程設(shè)計(jì)
給水處理廠設(shè)計(jì)說(shuō)明書(shū)
設(shè)計(jì)組名
學(xué)生姓名
學(xué)
院
年級(jí)/專(zhuān)業(yè)
指導(dǎo)教師
完成日期
年
月
設(shè)計(jì)說(shuō)明書(shū)怎么寫(xiě),應(yīng)該注意什么?正確格式?
概要設(shè)計(jì)說(shuō)明書(shū)又可稱(chēng)系統(tǒng)設(shè)計(jì)說(shuō)明書(shū),這里所說(shuō)的系統(tǒng)是指程序系統(tǒng)。編制的目的是說(shuō)明對(duì)程序 系統(tǒng)的設(shè)計(jì)考慮,包括程序系統(tǒng)的基本處。流程、程序系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)。 運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等,為程序的詳細(xì)設(shè)計(jì)提供基礎(chǔ)。
編制概要設(shè)計(jì)說(shuō)明書(shū)的內(nèi)容,要求如下:
11.1引言
11.1. 1編寫(xiě)目的
11.1.2背景
11.1.3定義
11.1.4參考資料
11.2總體設(shè)計(jì)
11.2.1需求規(guī)定
11.2.2運(yùn)行環(huán)境
11.2.3基本設(shè)計(jì)概念和處理流程
11. 2. 4”結(jié)構(gòu)
11.2.5功能需求與程序的關(guān)系
11. 2. 6人工處理過(guò)程
11.2.7尚未解決的問(wèn)題
11.3接口設(shè)計(jì)
11.31用戶(hù)接口
11.32外部接口
11.3 3內(nèi)部接口
11.4運(yùn)行設(shè)計(jì)
11. 4. 1運(yùn)行模塊組合
11.4.2運(yùn)行控制
11.4.3運(yùn)行時(shí)間
11.5系統(tǒng)論據(jù)結(jié)構(gòu)設(shè)計(jì)
11. 5. 1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
11. 5. 2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
11.5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系
11. 6系統(tǒng)出錯(cuò)處理設(shè)計(jì)
11. 6. 1出錯(cuò)信息
11.6.2補(bǔ)救措施
11.6 3系統(tǒng)維護(hù)設(shè)計(jì)
概要設(shè)計(jì)說(shuō)明書(shū)的編寫(xiě)提示(參考件)
E.1引言
E.1.1編寫(xiě)目的
說(shuō)明編寫(xiě)這份概要設(shè)計(jì)說(shuō)明書(shū)的目的,指出預(yù)期的讀者。
E.1.2背景
說(shuō)明:
a.待開(kāi)發(fā)軟件系統(tǒng)的名稱(chēng);
b.列出此項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶(hù)以及將運(yùn)行該軟件的計(jì)算站(中心)。
E.1.3定義
列出本文件中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。
E.1.4參考資料
列出有關(guān)的參考文件,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同,上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表文件;
c.本文件中各處引用的文件、資料,包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。 列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說(shuō)明能夠得到這些文件資料的來(lái)源。
E.2總體設(shè)計(jì)
E.2.1需求規(guī)定
說(shuō)明對(duì)本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求,詳細(xì)的說(shuō)明可參見(jiàn)附錄C。
E.2.2運(yùn)行環(huán)境
簡(jiǎn)要地說(shuō)明對(duì)本系統(tǒng)的運(yùn)行環(huán)境(包括硬件環(huán)境和支持環(huán)境)的規(guī)定,詳細(xì)說(shuō)明參見(jiàn)附錄C。
E.2.3基本設(shè)計(jì)概念和處理流程
說(shuō)明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程,盡量使用圖表的形式。
E.2.4結(jié)構(gòu)
用一覽表及框圖的形式說(shuō)明本系統(tǒng)的系統(tǒng)元素(各層模塊、子程序、公用程序等)的劃分,扼要說(shuō)明每個(gè)系統(tǒng)元素的標(biāo)識(shí)符和功能,分層次地給出各元素之間的控制與被控制關(guān)系.
E.2.5功能器求與程序的關(guān)系
本條用一張如下的矩陣圖說(shuō)明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系:
E.2.6人工處理過(guò)程
說(shuō)明在本軟件系統(tǒng)的工作過(guò)程中不得不包含的人工處理過(guò)程(如果有的話(huà))。
E.2.7尚未問(wèn)決的問(wèn)題
說(shuō)明在概要設(shè)計(jì)過(guò)程中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問(wèn)題。
E.3 接口設(shè)計(jì)
E.3.1用戶(hù)接口
說(shuō)明將向用戶(hù)提供的命令和它們的語(yǔ)法結(jié)構(gòu),以及軟件的回答信息。
E.3.2外部接口
說(shuō)明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接 口關(guān)系。
E.3.3內(nèi)部接口
說(shuō)明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。
E.4運(yùn)行設(shè)計(jì)
E.4.1運(yùn)行模塊組合
說(shuō)明對(duì)系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合,說(shuō)明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊和支持軟件。
E.4.2運(yùn)行控制
說(shuō)明每一種外界的運(yùn)行控制的方式方法和操作步驟。
E.4.3運(yùn)行時(shí)間
說(shuō)明每種運(yùn)行模塊組合將占用各種資源的時(shí)間。
E.5系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)
E.5.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱(chēng)、標(biāo)識(shí)符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識(shí)、定義、長(zhǎng)度及它們之間的層次的或表格的相互關(guān)系。
E.5.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲(chǔ)要求,訪(fǎng)問(wèn)方法、存取單位、存取的物理關(guān)系(索引、設(shè)備、存儲(chǔ)區(qū)域)、設(shè)計(jì)考慮和保密條件。
E.5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系
說(shuō)明各個(gè)數(shù)據(jù)結(jié)構(gòu)與訪(fǎng)問(wèn)這些數(shù)據(jù)結(jié)構(gòu)的形式:
E.6系統(tǒng)出錯(cuò)處理設(shè)計(jì)
E.6.1出錯(cuò)信息
用一覽表的方式說(shuō)朗每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí),系統(tǒng)輸出信息的形式、含意及處理方法。
E.6.2補(bǔ)救措施
說(shuō)明故障出現(xiàn)后可能采取的變通措施,包括:
a.后備技術(shù)說(shuō)明準(zhǔn)備采用的后備技術(shù),當(dāng)原始系統(tǒng)數(shù)據(jù)萬(wàn)一丟失時(shí)啟用的副本的建立和啟動(dòng)的技術(shù),例如周期性地把磁盤(pán)信息記錄到磁帶上去就是對(duì)于磁盤(pán)媒體的一種后備技術(shù);
b.降效技術(shù)說(shuō)明準(zhǔn)備采用的后備技術(shù),使用另一個(gè)效率稍低的系統(tǒng)或方法來(lái)求得所需結(jié)果的某些部分,例如一個(gè)自動(dòng)系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄;
c.恢復(fù)及再啟動(dòng)技術(shù)說(shuō)明將使用的恢復(fù)再啟動(dòng)技術(shù),使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從頭開(kāi)始重新運(yùn)行的方法。
E.6.3系統(tǒng)維護(hù)設(shè)計(jì)
說(shuō)明為了系統(tǒng)維護(hù)的方便而在程序內(nèi)部設(shè)計(jì)中作出的安排,包括在程序中專(zhuān)門(mén)安排用于系統(tǒng)的檢查與維護(hù)的檢測(cè)點(diǎn)和專(zhuān)用模塊。 各個(gè)程序之間的對(duì)應(yīng)關(guān)系,可采用如下的矩陣圖的形式;
如何寫(xiě)詳細(xì)設(shè)計(jì)文檔
在大多數(shù)軟件項(xiàng)目中,要末不作詳細(xì)設(shè)計(jì),要么開(kāi)發(fā)完成后再補(bǔ)詳細(xì)設(shè)計(jì)文檔,質(zhì)量也不容樂(lè)觀,文檔與系統(tǒng)往往不能同步,使詳細(xì)設(shè)計(jì)文檔完全流于形式,對(duì)工作沒(méi)有起到實(shí)際的幫助。
·
詳細(xì)設(shè)計(jì)是相對(duì)概要設(shè)計(jì)而言的,是瀑布開(kāi)發(fā)流程的一個(gè)重要環(huán)節(jié),在概要設(shè)計(jì)的高層設(shè)計(jì)的基礎(chǔ)上,從邏輯上實(shí)現(xiàn)了每一模塊的功能,是編碼階段的主要參考資料,是從高層到低層、逐步精化思想的具體實(shí)現(xiàn)。
詳細(xì)設(shè)計(jì)文檔的內(nèi)容包括各個(gè)模塊的算法設(shè)計(jì),
接口設(shè)計(jì),
數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì),交互設(shè)計(jì)等。必須寫(xiě)清楚各個(gè)模塊/接口/公共對(duì)象的定義,列明各個(gè)模塊程序的
各種執(zhí)行條件與期望的運(yùn)行效果,還要正確處理各種可能的異常。
·
在開(kāi)發(fā)過(guò)程中,由需求及設(shè)計(jì)不正確、不完整所導(dǎo)致的問(wèn)題是項(xiàng)目進(jìn)度拖延、失敗的一個(gè)主要因素,而軟件系統(tǒng)的一個(gè)重要特性就是需求和設(shè)計(jì)的不斷構(gòu)建和改進(jìn),在寫(xiě)詳細(xì)設(shè)計(jì)文檔過(guò)程中,
詳細(xì)設(shè)計(jì)實(shí)際上是對(duì)系統(tǒng)的一次邏輯構(gòu)建,可以有效驗(yàn)證需求的完整性及正確性。
如果不寫(xiě)詳細(xì)設(shè)計(jì)文檔,一般就從概設(shè)直接進(jìn)入編碼階段,這時(shí)開(kāi)發(fā)人員所能參考的資料就是需求規(guī)格說(shuō)明書(shū)及頁(yè)面原型、數(shù)據(jù)庫(kù)設(shè)計(jì)等,不能直接進(jìn)行開(kāi)發(fā),需要進(jìn)行信息的溝通,把頁(yè)面原型不能體現(xiàn)的設(shè)計(jì)講清楚,這樣既容易遺忘,也容易發(fā)生問(wèn)題,詳細(xì)設(shè)計(jì)文檔可以作為需求人員、總體設(shè)計(jì)人員與開(kāi)發(fā)人員的溝通工具,把靜態(tài)頁(yè)面無(wú)法體現(xiàn)的設(shè)計(jì)體現(xiàn)出來(lái),包含整體設(shè)計(jì)對(duì)模塊設(shè)計(jì)的規(guī)范,體現(xiàn)對(duì)設(shè)計(jì)上的一些決策,例如選用的算法,對(duì)一些關(guān)鍵問(wèn)題的設(shè)計(jì)考慮等等,使開(kāi)發(fā)人員能快速進(jìn)入開(kāi)發(fā),提高溝通效率,減少溝通問(wèn)題。
對(duì)于系統(tǒng)功能的調(diào)整,后期的維護(hù),詳設(shè)文檔提供了模塊設(shè)計(jì)上的考慮、決策,包括模塊與整體設(shè)計(jì)的關(guān)系、模塊所引用的數(shù)據(jù)庫(kù)設(shè)計(jì)、重要操作的處理流程、重要的業(yè)務(wù)規(guī)則實(shí)現(xiàn)設(shè)計(jì)等等信息,提供了對(duì)模塊設(shè)計(jì)的概述性信息,闡明了模塊設(shè)計(jì)上的決策,配合代碼注釋?zhuān)梢韵鄬?duì)輕松讀懂原有設(shè)計(jì)。
·存在的問(wèn)題要由專(zhuān)門(mén)的人寫(xiě),是比較麻煩的,也是很需要時(shí)間的,會(huì)對(duì)進(jìn)度造成壓力,也容易形成工作瓶頸,使設(shè)計(jì)人員負(fù)擔(dān)過(guò)重,而開(kāi)發(fā)人員無(wú)事可作。對(duì)于現(xiàn)在一般的以數(shù)據(jù)庫(kù)為中心的管理系統(tǒng)而言,這個(gè)工作始終是要作的,區(qū)別只不過(guò)是不是形成專(zhuān)門(mén)文檔,形成文檔可能會(huì)多花一兩周時(shí)間,但相對(duì)于規(guī)避的風(fēng)險(xiǎn)和問(wèn)題來(lái)說(shuō),也是值得的,另外由于現(xiàn)在高級(jí)語(yǔ)言的流行,所以更詳細(xì)的設(shè)計(jì)應(yīng)該直接體現(xiàn)在代碼的設(shè)計(jì)上,而文檔則只體現(xiàn)設(shè)計(jì)上的一些決策,協(xié)調(diào)整體設(shè)計(jì)與模塊設(shè)計(jì)的關(guān)系,把頁(yè)面原型所不能體現(xiàn)的設(shè)計(jì)情況文檔化,所以所花費(fèi)的時(shí)間是有限的。
設(shè)計(jì)內(nèi)容容易過(guò)細(xì),但設(shè)計(jì)階段是不能考慮特別清楚地,時(shí)間也不允許。
對(duì)于這個(gè)問(wèn)題,一個(gè)對(duì)策是上邊所提到的,文檔只體現(xiàn)設(shè)計(jì)上的決策,頁(yè)面原型所不能反映的信息,詳細(xì)設(shè)計(jì)只體現(xiàn)總體設(shè)計(jì)對(duì)模塊設(shè)計(jì)的一些考慮,例如對(duì)功能的數(shù)據(jù)庫(kù)設(shè)計(jì)等等,而具體的實(shí)現(xiàn)實(shí)現(xiàn),則到代碼中再去實(shí)現(xiàn),相關(guān)的設(shè)計(jì)也僅體現(xiàn)在代碼中。
需求、設(shè)計(jì)需要不斷的被更新、構(gòu)建,則設(shè)計(jì)文檔需要不斷的重新調(diào)整,文檔的維護(hù)需要跟上,否則文檔和系統(tǒng)的同步就很難得到保障了,且造成多余的工作量。文檔的內(nèi)容易流于形勢(shì),質(zhì)量糟糕,不能成為開(kāi)發(fā)人員的參考手冊(cè),一是要建立起相關(guān)制度,如有修改,先改文檔,后作開(kāi)發(fā),從工作流程上切實(shí)保障文檔與系統(tǒng)的同步,二是要規(guī)范文檔質(zhì)量,對(duì)文檔該寫(xiě)什么,不該寫(xiě)什么,標(biāo)準(zhǔn)是什么,粒度是什么,語(yǔ)法應(yīng)該如何組織,有明確的標(biāo)準(zhǔn)和考慮,同時(shí),建立審計(jì)文檔評(píng)審、審核制度,充分保障系統(tǒng)的使用?!?/p>
首先是文檔的內(nèi)容,根據(jù)項(xiàng)目和團(tuán)隊(duì)的不同,詳細(xì)設(shè)計(jì)文檔的內(nèi)容也有所不同,一般說(shuō)來(lái),粒度不宜過(guò)細(xì),不能代替開(kāi)發(fā)人員的設(shè)計(jì)和思考,但要把有關(guān)設(shè)計(jì)的決策考慮進(jìn)去,包括與其他模塊、整體設(shè)計(jì)的關(guān)系、操作的處理流程,對(duì)業(yè)務(wù)規(guī)則的設(shè)計(jì)考慮等,有一個(gè)標(biāo)準(zhǔn)為,凡是頁(yè)面原型、需求規(guī)格說(shuō)明書(shū)所不能反映的設(shè)計(jì)決策,而開(kāi)發(fā)人員又需要了解的,都要寫(xiě)入文檔。
其次是文檔所面向的讀者,主要為模塊開(kāi)發(fā)人員、后期維護(hù)人員,模塊開(kāi)發(fā)人員通過(guò)詳細(xì)設(shè)計(jì)文檔和頁(yè)面原型來(lái)了解所開(kāi)發(fā)的功能,后期維護(hù)人員通過(guò)實(shí)際系統(tǒng)、模塊代碼、詳細(xì)設(shè)計(jì)文檔來(lái)了解一個(gè)功能。
再有就是誰(shuí)來(lái)寫(xiě)文檔,因?yàn)槲臋n主要考慮的是設(shè)計(jì)上的決策,所以寫(xiě)文檔的人應(yīng)該為負(fù)責(zé)、參加設(shè)計(jì)的技術(shù)經(jīng)理、資深程序員,根據(jù)團(tuán)隊(duì)情況和項(xiàng)目規(guī)模、復(fù)雜度的不同,也有所不同。
還需要保證文檔的可讀性、準(zhǔn)確性、一致性,要建立嚴(yán)格的文檔模板及標(biāo)準(zhǔn),保證文檔的可讀性及準(zhǔn)確性,同時(shí)建立審核及設(shè)計(jì)評(píng)審制度,來(lái)保障設(shè)計(jì)及文檔的質(zhì)量,另外在工作流程中要強(qiáng)調(diào),要先設(shè)計(jì)、先寫(xiě)文檔,再進(jìn)行開(kāi)發(fā)。
關(guān)于詳細(xì)設(shè)計(jì)書(shū)編寫(xiě)規(guī)范模板和初步設(shè)計(jì)文本編制規(guī)范的介紹到此就結(jié)束了,不知道你從中找到你需要的信息了嗎 ?如果你還想了解更多這方面的信息,記得收藏關(guān)注本站。
掃描二維碼推送至手機(jī)訪(fǎng)問(wèn)。
版權(quán)聲明:本文由飛速云SEO網(wǎng)絡(luò)優(yōu)化推廣發(fā)布,如需轉(zhuǎn)載請(qǐng)注明出處。