設計說明書怎麼寫，應該注意什麼 程式設計說明書怎麼寫

概要設計說明書又可稱系統設計說明書，這裡所說的系統是指程式系統。

編制的目的是說明對程式 系統的設計考慮，包括程式系統的基本處。流程、程式系統的組織結構、模組劃分、功能分配、介面設計。

執行設計、資料結構設計和出錯處理設計等，為程式的詳細設計提供基礎。編制概要設計說明書的內容，要求如下： 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系統維護設計 說明為了系統維護的方便而在程式內部設計中作出的安排，包括在程式中專門安排用於系統的檢查與維護的檢測點和專用模組。

各個程式之間的對應關係，可採用如下的矩陣圖的形式；。

程式說明書包括如下七個內容：

1.程式名稱；包括反映程式功能的文字名稱和識別符號。

2.程式所屬的系統、子系統或模組的名稱。

3.編寫程式所需使用的語言。

4.輸入的方式和格式：當程式有多種輸入時，分別對每種輸入方式與格式做出具體而細緻

的說明。

5.輸出的方式與格式：當程式有多種內容按不同方式輸出時，分別說明不同內容按不同方

式輸出時的格式。

6.程式處理過程說明：包括程式中使用的計算公式，數學模型和控制方法等。

7.程式執行環境說明：對程式執行所需要的輸入輸出裝置的型別和數量，計算機的記憶體及

硬碟容量，支援程式執行的作業系統等內容進行說明。

由於種種原因，在實際工作中不太重視程式說明書的編寫工作。這既不利於程式的設計工作，更不利於對程式的修改和維護工作。因為系統投入執行後，需要經常根據情況的變化進行調整和修改，如果沒有完善的文件資料，維護、修改就很難進行。

原發布者：鑫淼圖文

概要設計說明書1.1.引言1.1.1編寫目的本文件詳細說明公文流轉系統的總體設計思想和設計方法，以及如何實現公文流轉系統中各資訊資料流的處理流程，供詳細設計人員參考。1.1.2專案背景本文件為公司公文流轉標準系統設計，同時作為軟體開發文件的標準模式初稿，供系統設計人員參審。1.1.3定義本文件將引用下面的定義，在此加以說明：公文，泛指工作中使用的各種文體的辦公檔案，如合同、申請、報告、報表檔案、請假、計劃、通知、彙報、通報等。流轉，指公文被處理的過程，如擬稿、批示、傳遞、列印等。資料庫，指儲存特定資訊的計算機檔案，是資訊儲存的靜態形式，可以是計算機軟體系統特指的資料庫，也可以是特指的表或查詢。後臺處理，指不需要人工干預的、自動根據操作規則進行的資料處理過程。人工輸入，指通過滑鼠或鍵盤將文字資訊輸入給軟體或將控制命令傳遞給軟體的過程。複製，指將資料完全不變地儲存到另外一個數據庫中。其他定義符合計算機中的標準定義。1.1.4參考資料公文管理方法軟體工程規範資料庫管理系統（SQL）技術手冊1.2.任務概述1.2.1目標本文件設計目標是，通過對公文流轉過程的邏輯描述，說明如何實現計算機網路的公文流轉處理，作為詳細設計的必備參考資料。1.2.2執行環境本文件描述的處理過程依賴以下平臺：.0中文版MicrosoftSQLServer6.5Windows95,InternetExploer4.01.2.3需求概述公文流轉系統的需求主要包括以

中北大學

微機原理與組合語言

課 程 設 計 說 明 書

學生姓名： 學 號：

學 院：

專 業： 電腦科學與技術

題 目：

成績

指導教師 喬志偉、陳夠喜、徐志永

2011 年6月9日

1. 引言（大標題黑體四號字）

該題目的意義等 （小四號字宋體，1.5倍行距）

2.需求分析

該題目的需求分析（小四號字宋體，1.5倍行距）

3.總體設計

該題目的設計方案與系統構成，主要由文字組成，在必要時，可以新增一些圖或者表格。

4. 詳細設計（這一部分每個人應該是不同的）

用文字說明自己具體負責模組的實現過程和實現原理以及設計的程式的流程圖，必要時可以新增說明性的圖形或表格。

必須要寫出，為什麼這樣做來，也就是說，必須在掌握的基礎上編寫程式。

5. 軟體測試

說明自己模組的測試過程和測試原理。如果是組長，則要說明總體的測試情況。給出測試報告。

6. 程式清單

給出自己設計模組的程式清單。

7. 參考資料

說明自己在課程設計中參考的文獻資料，參考資料的格式如下：

[1] 作者1，作者2 . 圖書名稱 . 出版社 . 出版社地點 . 出版年. 參考頁碼範圍

裝訂次序：

1.課程設計說明書封面 2.任務書封面 3.任務書 4. 設計說明書正文

main()

{ int x,a=1,b=2,c=3,d=4;

x=(a<b)? a:b; x=(x<c)? x:c; x=(d>x)? x:d;

printf("%dn",x);

}

輸出結果是：

1

邏輯表示式？語句1：語句2 的意思是如果表示式為真，那麼執行語句1；如果表示式為假，那麼執行語句2

x=(a<b)?a:b；如果a<b的話，那麼x=a，否則x=b；因為1<2成立，所以x=a，即x=1

x=(x<c)?x:c，如果x<c的話，那麼x=x，否則x=c；因為2<3成立，所以x=x，即x=1;

x=(d>x)?x:d，如果d>x的話，那麼x=x，否則x=d；因為4>1成立，所以x=x，即x=1;

所以printf("%dn",x)的結果是輸出1，換行。

物件導向軟體設計說明書模板 1 概述 1.1 系統簡述 對系統要完成什麼，所面向的使用者以及系統執行的環境的簡短描述，這部分主要來源於需求說明書的開始部分。

1.2 軟體設計目標 這部分論述整個系統的設計目標，明確地說明哪些功能是系統決定實現而哪些時不準備實現的。同時，對於非功能性的需求例如效能、可用性等，亦需提及。

需求規格說明書對於這部分的內容來說是很重要的參考，看看其中明確了的功能性以及非功能性的需求。 這部分必須說清楚設計的全貌如何，務必使讀者看後知道將實現的系統有什麼特點和功能。

在隨後的文件部分，將解釋設計是怎麼來實現這些的。 1.3 參考資料 列出本文件中所引用的參考資料。

（至少要引用需求規格說明書） 1.4 修訂版本記錄 列出本文件修改的歷史紀錄。必須指明修改的內容、日期以及修改人。

2 術語表 對本文件中所使用的各種術語進行說明。如果一些術語在需求規格說明書中已經說明過了，此處不用再重複，可以指引讀者參考需求說明。

3 用例 此處要求系統用用例圖表述（UML），對每個用例（正常處理的情況）要有中文敘述。 4 設計概述 4.1 簡述 這部分要求突出整個設計所採用的方法（是物件導向設計還是結構化設計）、系統的體系結構（例如客戶/伺服器結構）以及使用到的相應技術和工具（例如OMT、Rose） 4.2 系統結構設計 這部分要求提供高層系統結構的描述，使用方框圖來顯示主要的元件及元件間的互動。

最好是把邏輯結構同物理結構分離，對前者進行描述。別忘了說明圖中用到的俗語和符號。

4.2.1 頂層系統結構 4.2.2 子系統1結構 4.2.3 子系統2結構 4.3 系統介面 各種提供給使用者的介面以及外部系統在此處要予以說明。如果在需求規格說明書中已經對使用者介面有了敘述，此處不用再重複，可以指引讀者參考需求說明。

如果系統提供了對其它系統的介面，比如說從其它軟體系統匯入/匯出資料，必須在此說明。 4.4 約束和假定 描述系統設計中最主要的約束，這些是由客戶強制要求並在需求說明書寫明的。

說明系統是如何來適應這些約束的。 另外如果本系統跟其它外部系統互動或者依賴其它外部系統提供一些功能輔助，那麼系統可能還受到其它的約束。

這種情況下，要求清楚地描述與本系統有互動的軟體型別（比如某某某資料庫軟體，某某某EMail軟體）以及這樣導致的約束（比如只允許純文字的Email）。 實現的語言和平臺也會對系統有約束，同樣在此予以說明。

對於因選擇具體的設計實現而導致對系統的約束，簡要地描述你的想法思路，經過怎麼樣的權衡，為什麼要採取這樣的設計等等。 5 物件模型 5.1 系統物件模型 提供整個系統的物件模型，如果模型過大，按照可行的標準把它劃分成小塊，例如可以把客戶端和伺服器端的物件模型分開成兩個圖表述。

物件圖應該包含什麼呢？ 在其中應該包含所有的系統物件。這些物件都是從理解需求後得到的。

要明確哪些應該、哪些不應該被放進圖中。 所有物件之間的關聯必須被確定並且必須指明聯絡的基數（一對一、一對多還是多對多，0..1,*,1..*）。

聚合和繼承關係必須清楚地確定下來。每個圖必須附有簡單的說明。

可能經過多次反覆之後才能得到系統的正確的物件模型。 6 物件描述 在這個部分敘述每個物件的細節，它的屬性、它的方法。

在這之前必須從邏輯上對物件進行組織。你可能需要用結構圖把物件按子系統劃分好。

為每個物件做一個條目。在系統物件模型中簡要的描述它的用途、約束（如只能有一個例項），列出它的屬性和方法。

如果物件是儲存在持久的資料容器中，標明它是持久物件，否則說明它是個臨時物件（transient object）。 對每個物件的每個屬性詳細說明：名字、型別，如果屬性不是很直觀或者有約束（例如，每個物件的該屬性必須有一個唯一的值或者值域是有限正整數等）。

對每個物件的每個方法詳細說明：方法名，返回型別，返回值，引數，用途以及使用的演算法的簡要說明（如果不是特別簡單的話）。如果對變數或者返回值由什麼假定的話，Pre-conditions和Post-conditions必須在此說明。

列出它或者被它呼叫的方法需要訪問或者修改的屬性。最後，提供可以驗證實現方法的測試案例。

6.1 子系統1中的物件 6.1.1 物件：物件1 用途： 約束： 永續性： 6.1.1.1 屬性描述： 1. 屬性：屬性1 型別： 描述： 約束： 2. 屬性：屬性2 6.1.1.2 方法描述： 1. 方法：方法1 返回型別： 引數： 返回值： Pre-Condition: Post-Condition： 讀取/修改的屬性： 呼叫的方法： 處理邏輯： 測試例：用什麼引數呼叫該方法，期望的輸出是什麼…… 7 動態模型 這部分的作用是描述系統如何響應各種事件。例如，可以建立系統的行為模型。

一般使用順序圖和狀態圖。 確定不同的場景（Scenario）是第一步，不需要確定所有可能的場景，但是必須至少要覆蓋典型的系統用例。

不要自己去想當然地創造場景，通常的策略是描述那些客戶可以感受得到的場景。 7.1 場景（Scenarios） 對每個場景做一則條目，包括以下內容： 場景名：給它一個可以望文生義的名字 場景描述：簡要敘述場景是幹什麼的以及發生的動作的順序。

順序圖：描述各種事件及事件發生的。

有的，網上可以搜到挺多，我不知道怎麼提供給你下載，這個你可以參考參考。

軟體使用說明書模板

1. 引言

1.1編寫目的【闡明編寫手冊的目的。指明讀者物件。】

1.2專案背景【說明專案來源、委託單位、開發單位及主管部門】

1.3 定義【列出手冊中使用的專門術語的定義和縮寫詞的原意】

1.4參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，

可包括：a.專案的計劃任務書、合同或批文；b.專案開發計劃；C. 需求規格說

明書；d.概要設計說明書；e。詳細設計說明書；f.測試計劃；g。手冊中引用

的其他資料、採用的軟體工程標準或軟體工程規範。】

2. 軟體概述

2.1目標

2.2功能

2.3 效能

a.資料精確度【包括輸入、輸出及處理資料的精度】

b.時間特性【如響應時間、處理時間、資料傳輸時間等。】

c.靈活性【在操作方式、執行環境需做某些變更時軟體的適應能力。】

3. 執行環境

3.1硬體【列出軟體系統執行時所需的硬體最小配置，如a. 計算機型號、主存容量；b.

外儲存器、媒體、記錄格式、裝置型號及數量；c。輸入、輸出裝置；d.資料傳輸設

備及資料轉換裝置的型號及數量。】

3.2支援軟體【如：a。作業系統名稱及版本號；b. 語言編譯系統或彙編系統的名稱及版

本號；C。資料庫管理系統的名稱及版本號；d.其他必要的支援軟體。】

4. 使用說明

4.1安裝和初始化【給出程式的儲存形式、操作命令、反饋資訊及其含意、表明安裝完成

的測試例項以及安裝所需的軟體工具等。】

4.2輸入【給出輸入資料或引數的要求。】

4.2.1資料背景【說明資料來源、儲存媒體、出現頻度、限制和質量管理等。】

4.2.2資料格式【如：a。長度；b.格式基準；C，標號；d.順序；e。分隔符；f.

詞彙表；g. 省略和重複；h.控制。】

4.2.3輸入舉例

4.3輸出【給出每項輸出資料的說明】

4.3.l資料背景【說明輸出資料的去向使用頻度、存放媒體及質量管理等。】

4.3.2資料格式【詳細闡明每一輸出資料的格式，如：首部、主體和尾部的具體形式。】

4.3.3舉例

4.4出錯和恢復【給出：a。出錯資訊及其含意；b.使用者應採取的措施，如修改、恢復、

再啟動.】

4.5求助查詢【說明如何操作】

5. 執行說明

5.1執行表【列出每種可能的執行情況，說明其執行目的。】

5.2執行步驟【按順序說明每種執行的步驟，應包括：】

5.2.1執行控制

5.2.2操作資訊

a. 執行目的；b.操作要求；C。啟動方法； d.預計執行時間；e。操作命令格

式及格式說明；f.其他事項。

5.2.3輸入/輸出檔案【給出建立或更新檔案的有關資訊，如：】

a.檔案的名稱及編號；b.記錄媒體；C。存留的目錄；d.檔案的支配

【說明確定保留檔案或廢棄檔案的準則，分發檔案的物件，佔用硬體的優先

級及保密控制等.】

5.2.4啟動或恢復過程

6. 非常規過程

【提供應急或非常規操作的必要資訊及操作步驟，如出錯處理操作、向後備系統切換操作以

及維護人員須知的操作和注意事項。】

7. 操作命令一覽表

【按字母順序逐個列出全部操作命令的格式、功能及引數說明。】

8. 程式檔案（或命令檔案）和資料檔案一覽表

【按檔名字母順序或按功能與模組分類順序逐個列出檔名稱、識別符號及說明。】

9. 使用者操作舉例