設計說明書怎麼寫,應該注意什麼?正確格式

2021-03-03 20:30:14 字數 5233 閱讀 6612

1樓:匿名使用者

概要設計說明書又可稱系統設計說明書,這裡所說的系統是指程式系統。編制的目的是說明對程式 系統的設計考慮,包括程式系統的基本處。流程、程式系統的組織結構、模組劃分、功能分配、介面設計。

執行設計、資料結構設計和出錯處理設計等,為程式的詳細設計提供基礎。

編制概要設計說明書的內容,要求如下:

11.1引言

11.1. 1編寫目的

11.1.2背景

11.1.3定義

11.1.4參考資料

11.2總體設計

11.2.1需求規定

11.2.2執行環境

11.2.3基本設計概念和處理流程

11. 2. 4」結構

11.2.5功能需求與程式的關係

11. 2. 6人工處理過程

11.2.7尚未解決的問題

11.3介面設計

11.31使用者介面

11.32外部介面

11.3 3內部介面

11.4執行設計

11. 4. 1執行模組組合

11.4.2執行控制

11.4.3執行時間

11.5系統論據結構設計

11. 5. 1邏輯結構設計要點

11. 5. 2物理結構設計要點

11.5.3資料結構與程式的關係

11. 6系統出錯處理設計

11. 6. 1出錯資訊

11.6.2補救措施

11.6 3系統維護設計

概要設計說明書的編寫提示(參考件)

e.1引言

e.1.1編寫目的

說明編寫這份概要設計說明書的目的,指出預期的讀者。

e.1.2背景

說明:a.待開發軟體系統的名稱;

b.列出此專案的任務提出者、開發者、使用者以及將執行該軟體的計算站(中心)。

e.1.3定義

列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。

e.1.4參考資料

列出有關的參考檔案,如:

a.本專案的經核准的計劃任務書或合同,上級機關的批文;

b.屬於本專案的其他已發表檔案;

c.本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。 列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的**。

e.2總體設計

e.2.1需求規定

說明對本系統的主要的輸入輸出專案、處理的功能效能要求,詳細的說明可參見附錄c。

e.2.2執行環境

簡要地說明對本系統的執行環境(包括硬體環境和支援環境)的規定,詳細說明參見附錄c。

e.2.3基本設計概念和處理流程

說明本系統的基本設計概念和處理流程,儘量使用圖表的形式。

e.2.4結構

用一覽表及框圖的形式說明本系統的系統元素(各層模組、子程式、公用程式等)的劃分,扼要說明每個系統元素的識別符號和功能,分層次地給出各元素之間的控制與被控制關係.

e.2.5功能器求與程式的關係

本條用一張如下的矩陣圖說明各項功能需求的實現同各塊程式的分配關係:

e.2.6人工處理過程

說明在本軟體系統的工作過程中不得不包含的人工處理過程(如果有的話)。

e.2.7尚未問決的問題

說明在概要設計過程中尚未解決而設計者認為在系統完成之前必須解決的各個問題。

e.3 介面設計

e.3.1使用者介面

說明將向使用者提供的命令和它們的語法結構,以及軟體的回答資訊。

e.3.2外部介面

說明本系統同外界的所有介面的安排包括軟體與硬體之間的介面、本系統與各支援軟體之間的接 口關係。

e.3.3內部介面

說明本系統之內的各個系統元素之間的介面的安排。

e.4執行設計

e.4.1執行模組組合

說明對系統施加不同的外界執行控制時所引起的各種不同的執行模組組合,說明每種執行所歷經的內部模組和支援軟體。

e.4.2執行控制

說明每一種外界的執行控制的方式方法和操作步驟。

e.4.3執行時間

說明每種執行模組組合將佔用各種資源的時間。

e.5系統資料結構設計

e.5.1邏輯結構設計要點

給出本系統內所使用的每個資料結構的名稱、識別符號以及它們之中每個資料項、記錄、文卷和系的標識、定義、長度及它們之間的層次的或**的相互關係。

e.5.2物理結構設計要點

給出本系統內所使用的每個資料結構中的每個資料項的儲存要求,訪問方法、存取單位、存取的物理關係(索引、裝置、儲存區域)、設計考慮和保密條件。

e.5.3資料結構與程式的關係

說明各個資料結構與訪問這些資料結構的形式:

e.6系統出錯處理設計

e.6.1出錯資訊

用一覽表的方式說朗每種可能的出錯或故障情況出現時,系統輸出資訊的形式、含意及處理方法。

e.6.2補救措施

說明故障出現後可能採取的變通措施,包括:

a.後備技術說明準備採用的後備技術,當原始系統資料萬一丟失時啟用的副本的建立和啟動的技術,例如週期性地把磁碟資訊記錄到磁帶上去就是對於磁碟**的一種後備技術;

b.降效技術說明準備採用的後備技術,使用另一個效率稍低的系統或方法來求得所需結果的某些部分,例如一個自動系統的降效技術可以是手工操作和資料的人工記錄;

c.恢復及再啟動技術說明將使用的恢復再啟動技術,使軟體從故障點恢復執行或使軟體從頭開始重新執行的方法。

e.6.3系統維護設計

說明為了系統維護的方便而在程式內部設計中作出的安排,包括在程式中專門安排用於系統的檢查與維護的檢測點和專用模組。 各個程式之間的對應關係,可採用如下的矩陣圖的形式;

課程設計說明書的格式是怎樣的?

2樓:匿名使用者

課程設計說明書撰寫格式

為了保證課程設計質量,特制定本規範。

設計說明書要求按統一格式列印,其版面要求:a4紙,頁邊距:上2cm,下

2cm,左 2.5cm、右 2cm;字型:正文宋體、小四號;行距:固定值 20;頁碼:

底部居中。

一份完整的設計說明書應包括以下幾個方面:

一、封面(包括題目、院系、學生班級、設計組號、學生組員姓名、指導

教師姓名等)(見附 1)。

二、目錄

居中列印目錄二字,(四號黑體,段後 1 行),字間空一字元;章、節、小

節及其開始頁碼(字型均為小四號宋體)。節向右縮排兩個字元,小節及以後標

題均向右縮排四個字元。目錄中應包含正文及其後面部分的條目。目錄的最後一

項是無序號的「參考文獻資料」。

三、正文

(一)正文內容一般應包括:

1、設計任務和要求:說明本課題應解決的主要問題及應達到的技術要求;

簡述本設計的指導思想。

2、設計依據和設計原則。

3、方案論證:闡明為什麼要選擇這個設計方案以及所採用方案的特點。

4、設計論述:對設計工作的詳細表述(包括設計計算)。要求層次分明、表

達確切。

5、結論或總結:對整個設計工作進行歸納和綜合。

(二)正文要求:

(1)計算正確,論述清楚,文字簡練通順,插圖簡明,書寫整潔。文中圖、

表按製圖要求繪製。

(2) 段落及層次要求: 每節標題以四號黑體左起列印 (段前段後各0.5行) ,

節下為小節,以小四號黑體左起列印(段前段後各 0.5 行)。換行後以小四號宋

體列印正文。節、小節分別以1、1.1、1.1.1依次標出,空一字元後接各部分的標題。

當**結構複雜, 小節以下的標題, 左起頂格書寫, 編號依次用 (1) 、 (2) ……

或 1)、2)……順序表示。字型為小四號宋體。

對條文內容採用分行並敘時,其編號用(a)、(b)……或 a)、b)……

順序表示,如果編號及其後內容新起一個段落,則編號前空兩個中文字元。

(3)圖紙要求:圖面整潔,佈局合理,線條粗細均勻,圓弧連線光滑,尺

寸標註規範,使用計算機繪圖。

(4)曲線圖表要求:所有曲線、圖表、線路圖、流程圖、程式框圖、示意

圖等不準徒手畫,必須按國家規定標準或工程要求繪製(採用計算機輔助繪圖) 。

(5)課程設計說明書(報告)中圖表、公式要求如下:

(a)圖:圖的名稱採用中文,中文字型為五號宋體,圖名在**下面。引

用圖應在圖題右上角標出文獻**。圖號以章為單位順序編號。格式為:圖1-1,

空一字元後,接圖名。

(b)**:表的名稱及表內文字採用中文,中文字型為五號宋體,表名在

**上面。 表號以章為單位順序編號, 表內必須按規定的符號標註單位。 格式為:

表 1-1,空一字元後,接**名稱。

(c)公式:公式書寫應在文中另起一行,居中排列。公式序號按章順序編

號。字型為五號宋體,序號靠頁面右側。格式為:(1-1)……。

四、設計體會及今後的改進意見

五、參考文獻(資料)

參考文獻: 另起一頁, 居中列印參考文獻四字 (四號黑體, 段前段後1行) ,

字間空一字元;另起一行,按**中參考文獻出現的先後順序用阿拉伯數字連續

編號(參考文獻應在正文中注出);參考文獻中每條專案應齊全(字型均為小四

號宋體)。(格式:[編號]作者.**或著作名稱.期刊名或出版社.出版時間)。

(期刊應註明第幾期、起止頁數(包括論著))。

六、課程設計資料的裝訂

課程設計說明書按以下順序裝訂成冊:封面、目錄、正文、設計體會及今

後的改進意見、參考文獻;設計任務書、設計說明書(報告)和圖紙等裝入課程

設計專用袋中。 附 1

課程設計

給水處理廠設計說明書

設計組名

學生姓名

學 院

年級/專業

指導教師

完成日期 年 月

詳細設計說明書到底怎麼寫?

3樓:筆筆哇

詳細設計,這是考驗技術專家設計思維的重要關卡,詳細設計說明書應當把具體的模組以最』乾淨』的方式(黑箱結構)提供給編碼者,使得系統整體模組化達到最大;一份好的詳細設計說明書,可以使編碼的複雜性減低到最低,實際上,嚴格的講詳細設計說明書應當把每個函式的每個引數的定義都精精細細的提供出來,從需求分析到概要設計到完成詳細設計說明書,一個軟體專案就應當說完成了一半了。換言之,一個大型軟 件系統在完成了一半的時候,其實還沒有開始一行**工作。

那些把作軟體的程式設計師簡單理解為寫**的,就從根子上犯了錯誤了。

4樓:雪芃長流如

根據軟體功能來進行寫,先編寫好大綱,這樣在大綱的基礎上就比較好寫了。

機械設計課程設計說明書,機械設計課程說明書

文庫精選 內容來自使用者 嘰哩嘎啦 設計計算說明書 設計題目 蜂窩煤成型機 一課程設計的任務 3二電動機的選擇 4三傳動裝置的總傳動比和分配各級傳動比 5四傳動裝置的運動和動力引數的計算 5五傳動零件的設計計算 6六軸的設計 校核 19七滾動軸承的選擇和計算 33八鍵連線的選擇和計算 37九聯軸器的...

請問畢業設計的開題報告和設計說明書該怎麼寫

我給你一個提綱 西安交通大學 工程碩士學位 選題報告書 畢業設計的開題報告怎麼寫?急!10 開題報告前肯定寫過文獻綜述了吧,基本上從那複製貼上就可以了。主要寫1 選題的歷史背景 國內外研究現狀和發展趨勢2 研究的基本內容和擬解決的主要問題 3 研究方法和措施 4 研究工作的步驟 進度 5 主要參考文...

機械設計說明書怎樣寫,如何寫機械裝置使用說明書

機械設計說明書具體需要的內容包括。1 標題。設計課題的名稱。要求描述清楚。2 任務書。應說明設計目的和任務要求。要求 扼要敘述本設計的主要內容 特點 引數效能 要達成的成果及驗收標準。3 技術方案。詳細說明達成設計的技術方案 工藝方案 生產製做方案等,著重描述技術難點的解決方法及所需資源。4 設計資...