如何編寫設(shè)計(jì)文檔PPT模板

2024年3月如何編寫概要設(shè)文檔主講人：張?jiān)迫~開發(fā)中相關(guān)文檔需求說明書產(chǎn)品/項(xiàng)目方案概要設(shè)計(jì)詳細(xì)設(shè)計(jì)接口規(guī)范文檔技術(shù)架構(gòu)規(guī)范開發(fā)中相關(guān)文檔在軟件開發(fā)過程中，方案、概要設(shè)計(jì)和詳細(xì)設(shè)計(jì)是不同層次的設(shè)計(jì)文檔，用于指導(dǎo)和記錄軟件系統(tǒng)的設(shè)計(jì)和實(shí)現(xiàn)過程。它們之間的區(qū)別如下：方案（Solution）：方案是最高層次的設(shè)計(jì)文檔，通常由項(xiàng)目經(jīng)理或架構(gòu)師編寫。方案旨在提供解決問題或?qū)崿F(xiàn)目標(biāo)的整體策略和規(guī)劃，包括系統(tǒng)的總體結(jié)構(gòu)、核心功能模塊、技術(shù)選型、資源分配等。方案通常較為宏觀，不涉及具體實(shí)現(xiàn)細(xì)節(jié)。概要設(shè)計(jì)（High-LevelDesign）：概要設(shè)計(jì)是在方案基礎(chǔ)上進(jìn)行的更加詳細(xì)的設(shè)計(jì)文檔，通常由系統(tǒng)設(shè)計(jì)師或架構(gòu)師編寫。概要設(shè)計(jì)關(guān)注系統(tǒng)各個(gè)組件之間的接口和交互方式，包括模塊劃分、模塊之間的關(guān)系、數(shù)據(jù)流程、系統(tǒng)流程控制等。概要設(shè)計(jì)描述了系統(tǒng)的整體框架和結(jié)構(gòu)，但對(duì)于具體實(shí)現(xiàn)的細(xì)節(jié)并不詳細(xì)涉及。詳細(xì)設(shè)計(jì)（DetailedDesign）：詳細(xì)設(shè)計(jì)是在概要設(shè)計(jì)的基礎(chǔ)上進(jìn)行的更加具體和詳細(xì)的設(shè)計(jì)文檔，通常由開發(fā)人員編寫。詳細(xì)設(shè)計(jì)關(guān)注每個(gè)模塊或組件的具體實(shí)現(xiàn)方式，包括數(shù)據(jù)結(jié)構(gòu)、算法、函數(shù)接口、類和方法的設(shè)計(jì)等。詳細(xì)設(shè)計(jì)描述了系統(tǒng)的實(shí)現(xiàn)細(xì)節(jié)，提供了開發(fā)人員實(shí)現(xiàn)代碼的具體指導(dǎo)?？傮w而言，方案提供了整體的策略和規(guī)劃，概要設(shè)計(jì)提供了系統(tǒng)的整體框架和結(jié)構(gòu)，而詳細(xì)設(shè)計(jì)則關(guān)注具體的實(shí)現(xiàn)細(xì)節(jié)。這三個(gè)設(shè)計(jì)文檔在軟件開發(fā)過程中扮演著不同的角色，幫助團(tuán)隊(duì)成員理解和協(xié)同開發(fā)系統(tǒng)。如何進(jìn)行系統(tǒng)分析

架構(gòu)方法+場景分析1基本名稱說明容易混淆的名詞：系統(tǒng)與子系統(tǒng)、模塊與組件、框架與架構(gòu)。模塊與組件都是系統(tǒng)的組成部分，從不同角度拆分系統(tǒng)而已。模塊是邏輯單元，組件是物理單元。模塊就是從邏輯上將系統(tǒng)分解，即分而治之，將復(fù)雜問題簡單化。模塊的粒度可大可小，可以是系統(tǒng)，幾個(gè)子系統(tǒng)、某個(gè)服務(wù)，函數(shù)，類，方法、功能塊等等。劃分模塊的主要目的是職責(zé)分離。組件可以包括應(yīng)用服務(wù)、數(shù)據(jù)庫、網(wǎng)絡(luò)、物理機(jī)、還可以包括MQ、容器、Nginx等技術(shù)組件。劃分組件的主要目的的是單元復(fù)用。"組件"的英文單詞Component，對(duì)應(yīng)中文的"零件"一詞，"零件"更容易理解一些。"零件"是一個(gè)物理的概念,并且具備"獨(dú)立且可替換"的特點(diǎn)?，F(xiàn)在越來越多的UI設(shè)計(jì)使用組件化化和模塊化。框架是規(guī)范，架構(gòu)是結(jié)構(gòu)：框架和架構(gòu)的區(qū)別還是比較明顯的，框架關(guān)注的是"規(guī)范",架構(gòu)關(guān)注的是"結(jié)構(gòu)"：框架的英文是Framework，例如，SpringMVC是"WebMVCFramework"；

架構(gòu)的英文是Architecture，例如，Linux操作系統(tǒng)的架構(gòu)。用例圖架構(gòu)領(lǐng)域，有兩種常見架構(gòu)方法RUP和TOGAF,不同架構(gòu)方法論，定義的架構(gòu)分類也不同RUP4+1架構(gòu)方法主要是以架構(gòu)生命周期為視角進(jìn)行描述，而TOGAF9按架構(gòu)涉及內(nèi)容維度來描述。因此我結(jié)合兩者細(xì)分為業(yè)務(wù)架構(gòu)、應(yīng)用架構(gòu)、數(shù)據(jù)架構(gòu)、技術(shù)架構(gòu),代碼架構(gòu),部署架構(gòu)。架構(gòu)設(shè)計(jì)方法TOGAF9架構(gòu)分類邏輯視圖：用于描述系統(tǒng)軟件功能拆解后的組件關(guān)系,組件約束和邊界,反映系統(tǒng)整體組成與系統(tǒng)如何構(gòu)建的過程。關(guān)注功能和邏輯層。開發(fā)視圖：描述系統(tǒng)的模塊劃分和組成,以及細(xì)化到內(nèi)部包的組成設(shè)計(jì),服務(wù)于開發(fā)人員,反映系統(tǒng)開發(fā)實(shí)施過程。物理視圖：描述軟件如何映射到硬件，反映系統(tǒng)在分布方面的設(shè)計(jì)，系統(tǒng)的組件是如何部署到一組可計(jì)算機(jī)器節(jié)點(diǎn)上,用于指導(dǎo)軟件系統(tǒng)的部署實(shí)施過程。處理流程視圖：用于描述系統(tǒng)軟件組件之間的通信時(shí)序,數(shù)據(jù)的輸入輸出,反映系統(tǒng)的功能流程與數(shù)據(jù)流程,通常由時(shí)序圖和流程圖表示。關(guān)注進(jìn)程、線程、對(duì)象等運(yùn)行時(shí)概念以及相關(guān)的并發(fā)、同步、通信等問題。RUP4+1架構(gòu)視圖用例圖用例圖（工位，流程，角色..)從用戶場景引導(dǎo)進(jìn)行模型，架構(gòu)設(shè)計(jì)流程編寫合格的概要設(shè)計(jì)文檔

流程規(guī)范+重點(diǎn)問題2

概要設(shè)計(jì)的主要任務(wù)是把需求分析得到的系統(tǒng)擴(kuò)展用例圖轉(zhuǎn)換為軟件結(jié)構(gòu)和數(shù)據(jù)結(jié)構(gòu)。

設(shè)計(jì)軟件結(jié)構(gòu)的具體任務(wù)是：將一個(gè)復(fù)雜系統(tǒng)按功能進(jìn)行模塊劃分、建立模塊的層次結(jié)構(gòu)及調(diào)用關(guān)系、確定模塊間的接口及人機(jī)界面等。

數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)包括數(shù)據(jù)特征的描述、確定數(shù)據(jù)的結(jié)構(gòu)特性、以及數(shù)據(jù)庫的設(shè)計(jì)。

顯然，概要設(shè)計(jì)建立的是目標(biāo)系統(tǒng)的邏輯模型，與具體計(jì)算機(jī)硬件無深度關(guān)系。什么是概要設(shè)計(jì)需求目標(biāo)總體/功能架構(gòu)部署架構(gòu)關(guān)鍵模型對(duì)外接口核心流程核心算法按照模塊來細(xì)化概要設(shè)計(jì)的流程和步驟編寫概要設(shè)計(jì)是在技術(shù)方案的基礎(chǔ)上進(jìn)一步詳細(xì)闡述系統(tǒng)的設(shè)計(jì)思路、模塊劃分和交互方式。項(xiàng)目背景和目標(biāo)：介紹項(xiàng)目的背景和目標(biāo)，包括項(xiàng)目的業(yè)務(wù)需求、用戶需求和系統(tǒng)目標(biāo)。明確需要解決的問題和實(shí)現(xiàn)的功能。系統(tǒng)架構(gòu)概述：概述系統(tǒng)的整體架構(gòu)，包括各個(gè)組件、模塊和層次結(jié)構(gòu)之間的關(guān)系和交互方式。用框圖或圖表等形式呈現(xiàn)系統(tǒng)的結(jié)構(gòu)。功能模塊劃分：根據(jù)項(xiàng)目需求，將系統(tǒng)拆分為不同的功能模塊或子系統(tǒng)。對(duì)每個(gè)模塊進(jìn)行詳細(xì)描述，包括其功能、輸入輸出、依賴關(guān)系等。模塊接口定義：定義每個(gè)模塊之間的接口和交互方式。包括數(shù)據(jù)傳輸格式、接口參數(shù)、接口調(diào)用順序等。確保模塊之間的通信和數(shù)據(jù)流暢通。數(shù)據(jù)庫設(shè)計(jì)：如果項(xiàng)目涉及數(shù)據(jù)存儲(chǔ)和管理，設(shè)計(jì)數(shù)據(jù)庫結(jié)構(gòu)和表關(guān)系。定義數(shù)據(jù)庫中的表、字段、索引等。確保數(shù)據(jù)的一致性和完整性。類和對(duì)象設(shè)計(jì)：根據(jù)功能模塊的劃分，設(shè)計(jì)類和對(duì)象的結(jié)構(gòu)和關(guān)系。定義類之間的繼承關(guān)系、關(guān)聯(lián)關(guān)系、接口等。用類圖或?qū)ο髨D等形式進(jìn)行表示。概要設(shè)計(jì)的流程和步驟說明7.類和對(duì)象設(shè)計(jì)：根據(jù)功能模塊的劃分，設(shè)計(jì)類和對(duì)象的結(jié)構(gòu)和關(guān)系。定義類之間的繼承關(guān)系、關(guān)聯(lián)關(guān)系、接口等。用類圖或?qū)ο髨D等形式進(jìn)行表示。8.系統(tǒng)流程圖：繪制系統(tǒng)的主要業(yè)務(wù)流程圖，描述用戶與系統(tǒng)的交互過程。包括用戶輸入、系統(tǒng)處理和輸出結(jié)果。確保流程的合理性和完整性。9.異常處理和錯(cuò)誤處理：定義系統(tǒng)中可能出現(xiàn)的異常情況和錯(cuò)誤處理機(jī)制。包括異常的捕獲和處理方式、錯(cuò)誤提示和恢復(fù)策略等。10.安全設(shè)計(jì)：考慮系統(tǒng)的安全需求，設(shè)計(jì)相應(yīng)的安全策略和機(jī)制。包括身份認(rèn)證、權(quán)限控制、數(shù)據(jù)加密、漏洞防護(hù)等方面的設(shè)計(jì)和實(shí)施。11.性能優(yōu)化設(shè)計(jì)：針對(duì)系統(tǒng)的性能需求，提出性能優(yōu)化的設(shè)計(jì)方案。包括緩存策略、并發(fā)控制、數(shù)據(jù)庫優(yōu)化等。確保系統(tǒng)具有高性能和可擴(kuò)展性。12.接口文檔和API定義：編寫接口文檔，描述每個(gè)模塊的API接口和調(diào)用方式。包括參數(shù)說明、返回結(jié)果、錯(cuò)誤碼等。確保接口的規(guī)范和易用性。13.部署和運(yùn)維計(jì)劃：制定系統(tǒng)的部署和運(yùn)維計(jì)劃，包括環(huán)境配置、部署流程、監(jiān)控方案、故障處理等。確保系統(tǒng)的可用性和穩(wěn)定性。概要設(shè)計(jì)的流程和步驟說明整體架構(gòu)（業(yè)務(wù)架構(gòu)）<繪制本產(chǎn)品與其他外部實(shí)體之間的結(jié)構(gòu)關(guān)系圖。該圖應(yīng)包含本系統(tǒng)、外部實(shí)體以及它們之間的數(shù)據(jù)流。該圖將定義產(chǎn)品的邊界、與外部環(huán)境接口的界面，如：與其它產(chǎn)品、應(yīng)用系統(tǒng)、網(wǎng)絡(luò)、組織運(yùn)行機(jī)構(gòu)的接口等。該圖顯示了本產(chǎn)品所需的資源（如數(shù)據(jù)、消息、事件、文件）的來源，并描繪產(chǎn)品的反應(yīng)和輸出。結(jié)構(gòu)關(guān)系圖不側(cè)重描述產(chǎn)品的內(nèi)部結(jié)構(gòu)和流程。>PictureContent_baseContent_VODContent_SeriesProgramMovie_fileContent_ProgramEpisodeN11NNNNN子類

子類

Content_ArticleChannel/…..核心模型設(shè)計(jì)：內(nèi)容模型接口設(shè)計(jì)要求和場景，流程的對(duì)應(yīng)字段定義清晰關(guān)鍵業(yè)務(wù)對(duì)象，預(yù)留保留字段重要接口安全性要求場景理解和提升接口是模型的映射反應(yīng)接口定義的基本要求根據(jù)擴(kuò)展的場景來定義接口，而不是只根據(jù)現(xiàn)在的場景來定義接口接口是核心模型對(duì)外服務(wù)的映射，ER關(guān)系不變，后續(xù)擴(kuò)展，也不會(huì)影響太大a.要明確模型之間的關(guān)系，b.BO和DTO的轉(zhuǎn)化

功能定義要求確定功能模塊：根據(jù)需求分析和系統(tǒng)設(shè)計(jì)，確定系統(tǒng)中的各個(gè)功能模塊。每個(gè)功能模塊應(yīng)當(dāng)以一個(gè)獨(dú)立的功能或一組相關(guān)功能為基礎(chǔ)。描述功能：對(duì)于每個(gè)功能模塊，明確描述其具體功能和預(yù)期的行為。簡潔明了地說明模塊實(shí)現(xiàn)的目標(biāo)是什么，它將如何滿足需求，并實(shí)現(xiàn)哪些具體的操作或處理。劃定接口：對(duì)于每個(gè)功能模塊，確定其與其他模塊之間的接口。這包括輸入?yún)?shù)、輸出參數(shù)、調(diào)用關(guān)系、數(shù)據(jù)依賴關(guān)系等。確保各個(gè)功能模塊之間的接口清晰定義，便于團(tuán)隊(duì)成員理解和協(xié)同開發(fā)。詳細(xì)設(shè)計(jì)+UML等其他流程規(guī)范+重點(diǎn)問題3可迭代的敏捷開發(fā)方式敏捷要求在一個(gè)相對(duì)穩(wěn)定的框架（模型，架構(gòu)，對(duì)外接口..)下進(jìn)行實(shí)現(xiàn)層面的分階段小步快跑，不是開始快，后面反復(fù)調(diào)整框架，進(jìn)行事后補(bǔ)賬。如造一個(gè)大樓，整體框架確定后，可以分階段并行去做，先做2層，先做毛胚，在做裝修，在做水電…前題要求理解需求和場景，核心模型和接口要基本設(shè)計(jì)到位實(shí)現(xiàn)技巧一個(gè)場景一個(gè)場景實(shí)現(xiàn)，完成整體場景流程后臺(tái)服務(wù)的邏輯，可以使用存儲(chǔ)過程來實(shí)現(xiàn)采用封裝隔離的方式，可將初期臨時(shí)的模塊做替換4.

前端按照正式場景，定義JSAPI+Mock來快速開發(fā)詳細(xì)設(shè)計(jì)做那些數(shù)據(jù)庫設(shè)計(jì)：如果項(xiàng)目涉及數(shù)據(jù)存儲(chǔ)和管理，設(shè)計(jì)數(shù)據(jù)庫結(jié)構(gòu)和表關(guān)系。定義數(shù)據(jù)庫中的表、字段、索引等。確保數(shù)據(jù)的一致性和完整性。類和對(duì)象設(shè)計(jì)：根據(jù)功能模塊的劃分，設(shè)計(jì)類和對(duì)象的結(jié)構(gòu)和關(guān)系。定義類之間的繼承關(guān)系、關(guān)聯(lián)關(guān)系、接口等。用類圖或?qū)ο髨D等形式進(jìn)行表示。系統(tǒng)流程圖：繪制系統(tǒng)的主要業(yè)務(wù)流程圖，描述用戶與系統(tǒng)的交互過程。包括用戶輸入、系統(tǒng)處理和輸出結(jié)果。確保流程的合理性和完整性結(jié)構(gòu)型的圖(StructureDiagram)類圖(ClassDiagram)對(duì)象圖(ObjectDiagram)構(gòu)件圖(ComponentDiagram)