| 〇、概念 概要設計文檔是一個框架設計文檔，指出了設計的大體思路。與詳細設計文檔不同，它沒有詳細設計文檔描述的細致入微。但是一份好的概要設計文檔，對于一個高級軟件工程師來說，完全有能力進行系統(tǒng)實現(xiàn)了。 一、一般格式 文檔格式如同人的相貌，以貌取人，雖然不合理，但是有它的普遍性。下面給出一個范例： 1.0文檔的封面 封面是最籠統(tǒng)的概括，一般包括文件名稱、文件編號、項目名稱、項目編號、文件密級、文件版本、文件作者、文件狀態(tài)等信息。例如: XXX公司技術文件（居中） 文件名稱：XXX概要設計 文件編號：A00-B00-000XXX（編號符合自己公司的標準即可） 項目名稱：XXX項目（寫自己的項目名稱） 項目編號：A00000XXX（符合自己公司的標準） 文件作者：魏雷遠 文件版本：A(按什么編號都可以，可以為阿拉伯編碼、希臘字母編碼等) 文件狀態(tài)：PRE 文件密級：絕密 ...... 對于有版本控制的文件，還要有版本變更的記錄，審核人，審核日期，批準人，批準日期，修訂信息等。 1.1文件修訂頁 文件修訂頁的目的是記錄該文件的詳細修改記錄，一般包括修改的章節(jié)、內(nèi)容、日期、修改人、批準人等等。按表格形式進行記錄 1.2索引和目錄 這部分可以根據(jù)概要設計文檔內(nèi)容自動生成。不熟悉Word者，按如下操作：插入菜單->引用->索引和目錄，按照提示進行操作。 1.3文件正文部分 此部分是概要設計文檔的核心部分。下面給出我做的項目（軟件）的一個范例： 1.范圍 1.1系統(tǒng)概述 簡單描述系統(tǒng)結(jié)構或組成。 1.2文檔概述 簡要描述概要設計文檔涉及的內(nèi)容以及適用的對象。 1.3術語與縮略語 解釋概要設計中的術語和縮略語。 ===當然，還可以加入其它內(nèi)容。 2.引用文檔 列出參考文檔或者依據(jù)。 3.總體設計 3.1軟件體系結(jié)構 描述軟件體系結(jié)構，一定要給出圖來，直觀、清晰、簡單、明了。 3.2子系統(tǒng)間的關系 列出組成軟件的各個子系統(tǒng)間的相互關系。還是要給出圖來。 4.子系統(tǒng)設計 這部分根據(jù)劃分的子系統(tǒng)分別描述各部分的功能。說明簡單的數(shù)據(jù)流程即可。細節(jié)部分在詳細設計文檔中體現(xiàn)。 二、說明 2.1與需求文檔的關系 概要設計文檔是需求文檔的輸出，使需求的一個實現(xiàn)輪廓。也就是說，在概要設計文檔中可以看出系統(tǒng)的大概面貌。打個比方說，如果需求文檔要求做一個石油行業(yè)MIS系統(tǒng)，用于銷售的。那么概要設計要確定這個系統(tǒng)的架構、主要功能模塊：數(shù)據(jù)錄入、統(tǒng)計、查詢、修改、分析等。以及這些模塊的大概組成。如分析模塊，需要確定數(shù)據(jù)的分析算法。 2.2與詳細設計的關系 概要設計文檔是詳細設計文檔的輸入。詳細設計需要對此進行細化。用程序員利于理解的話來說，概要設計好比F10（Step Over），詳細設計好比是F11（Step In）。 2.3文字和圖表 無論是什么文檔，畫一幅圖，生于長篇大論。圖形就是簡單、直觀、清晰、明了、通俗、易懂。讓人一眼看出整體結(jié)構來。文字的話，還要讓人去理解，碰到不認識的字或者單詞就更郁悶了。 三、總結(jié) 文檔作為項目的重要參考，是進行維護的保證，同是屬于企業(yè)的產(chǎn)品。文檔需要進行合理的管理。 當然了，要寫好文檔，如果在Windows平臺上，請懂一點Office中Word，Excel，Visio等，其他工具Rose等，最好也要掌握一些。 后記：有時候，當我看到某公司的PM在不懂技術的情況下，同時不會用word，不會用excel，寫出來的文檔還趕不上本科生的畢業(yè)前，而深感他們需要在這方面提高一下自己的素質(zhì)。我們只需要掌握Office功能的0.5%，那我們可以寫出非常漂亮的文檔，給閱讀者以美的享受。 |
