AI概要設計文件評審實踐

背景

概要設計文件評審是軟體開發過程中的一個重要環節，主要體現在以下幾個方面：

1.確保設計的一致性和完整性：

透過評審，可以確保設計文件中描述的系統架構、模組劃分、介面定義等內容在各個部分之間保持一致，避免出現相互矛盾或遺漏的情況。

評審過程有助於發現設計中的潛在問題，如資料流不一致、模組功能重疊等，從而及時進行修正。

2.提升設計質量：

評審過程中，來自不同背景和專業的團隊成員可以提出各自的見解和建議，有助於發現設計中的不足之處，提升設計的質量和可行性。

透過集體智慧和經驗，可以最佳化設計方案，提高系統的效能、可靠性和可維護性。

3.降低開發風險：

早期發現設計中的潛在問題，可以在開發階段之前進行修正，避免在後期開發過程中出現重大變更，從而降低開發成本和風險。

評審還有助於識別可能存在的技術難點或挑戰，提前進行技術準備和攻關。

4.促進團隊協作與溝通：

評審過程是一個團隊協作和溝通的過程，有助於增強團隊成員之間的理解和信任。

透過評審，團隊成員可以更加清晰地瞭解專案的整體設計和各自的任務分工，為後續的開發工作打下良好的基礎。

5.滿足專案管理和合規要求：

評審是專案管理中的一個重要環節，有助於確保專案按照預定的進度和質量要求進行。

在某些情況下，評審還是滿足行業規範、客戶要求或法律法規的必要步驟。

提示詞

您是軟體工程評審專家，請根據上傳的《概要設計說明書模板v1.0.docx》檔案為基準，為我之後上傳{專案概要設計}評審進行評審，結合IT行業反饋詳細建議與存在的問題。

評審維度：

一.系統總體設計(系統總體相關架構設計及說明)

二.系統架構設計

設計過程及要點:系統架構主要分為橫向設計和縱向設計。

橫向設計關注系統內部不同功能模組之間的關係和互動。它包括分為渠道層、展示層、應用層、平臺層、資料層、基礎層、管理體系、服務體系、標準體系等，透過模組化和層次化的設計，實現系統的靈活性、可維護性和可擴充套件性。

縱向設計關注系統層次結構和元件之間的層次關係。它包括以下方面：

層次間的依賴關係：定義各個層次之間的依賴關係，確保高層次的模組依賴於底層的模組，實現各層次的解耦。

模組和元件的劃分：將系統劃分為不同的元件，並定義元件之間的介面和關係。

元件複用和擴充套件：設計可重用的元件，以便在不同系統中進行復用，並支援系統的擴充套件和定製化。橫向設計和縱向設計相互關聯，透過模組化和層次化的設計，實現系統的靈活性、可維護性和可擴充套件性。橫向設計關注系統內部的模組之間的協作和互動，而縱向設計則關注系統整體結構和層次關係。兩者共同構成了系統架構設計的完整框架。

三.技術架構設計

設計過程及要點:技術架構設計是構建穩定、可靠、高效能、可擴充套件軟體架構的基礎，也是將業務需求和系統功能轉變位技術實現的過程，涉及技術架構規劃、技術選型、架構製圖等，設計過程包含以下：

1. 技術架構規劃：分析系統需求(功能/非功能)，明確架構設計上下文，確定技術架構模式（如：單體、SOA、微服務等）；

2. 技術選型：結合技術架構模式、平臺類資源、團隊技術情況以及技術發展趨勢，規劃架構中可能涉及到的技術框架/平臺、中介軟體、快取、訊息佇列、資料庫等；

3. 架構製圖：一般採用分層結構描述技術架構，根據需要體現每層中使用的技術框架(棧)、技術路線，層間需要體現通訊協議，可以採用資訊流、控制流分別展示。

四.整合架構設計

設計過程及要點:整合架構綜合應用架構（應用整合部分）和技術架構（技術整合部分）的內容，主要體現整個軟體架構內外的整合(依賴)關係以及資訊流向，設計過程包含以下：

1. 應用整合關係梳理：梳理應用/微服務、外部系統/服務清單，根據使用者資訊/控制流向梳理整合關係；

2. 技術整合關係梳理：結合技術架構補充應用/微服務、外部系統/服務的通訊方式。

五.部署架構設計

設計過程及要點:部署架構設計是用來規劃軟體系統中軟體和硬體的物理架構。可以透過部署架構設計過程瞭解到軟體和硬體元件之間的物理關係以及處理節點的元件分佈、網路拓撲等情況，可以顯示執行時系統的結構，同時還傳達構成應用程式的硬體和軟體元素的配置和部署方式。

六.資料架構設計

設計過程及要點:DCMM（資料管理能力成熟度評估模型）中對資料架構的定義：透過組織級資料模型定義資料需求,指導對資料資產的分佈控制和整合,部署資料的共享和應用環境,以及後設資料管理的規範。包括資料模型、資料分佈、資料整合與共享、後設資料管理4部分

資料流設計可以採用資料流圖的方式進行設計和展現，它從資料傳遞和加工角度，以圖形方式來表達系統的邏輯功能、資料在系統內部的邏輯流向和邏輯變換過程。

資料模型設計透過明確系統對資料的需求，包括需要儲存和處理哪些資料，以及資料之間的關係，繪製實體關係圖，明確實體（表）之間的關係、屬性和約束條件。資料模型的設計過程中，需要考慮資料的定義和語義，這部分透過後設資料來體現，後設資料可以記錄資料模型中的實體、屬性、關係、約束等元素，幫助維護資料模型和資料的一致性。

七.系統功能設計

子系統/微服務1功能設計

系統/整合架構設計

技術架構設計

部署架構設計

核心業務流程/資料流圖/狀態圖

資料庫設計

子系統2功能設計

八.效能需求設計

九.安全需求設計

系統安全設計

網路安全設計

資料安全設計

密碼安全設計

日誌體系設計

十.高可用設計

Tips:《概要設計說明書模板v1.0》是公司軟體工程委員會多人稽核確定的 通用 概要設計文件模板，包含圖例

ChatGPT4o:

AI反饋評審建議

自動評分

評分提示詞

請以上傳的評分標準 結合之前上傳 《概要設計說明書模板v1.0》,對{}文件 進行評分

測試

請以上傳的打分標準 結合之前上傳 《概要設計說明書模板v1.0》,對《裝置控制系統軟體設計說明書》進行打分

架構圖評審

請評價上傳的系統架構圖，架構描述：“應用管理模組：如圖應用管理，提供各類輕應用及服務呼叫介面。平臺管理模組（橘色）：提供維護配置執行引數、角色許可權控制、客戶管理等。對賬中心模組（綠色）：提供對外系統的對賬，以及內部各類賬戶的對賬，確保資金流向的正確性，異常時可預警，並能對異常情況進行處理。支付核心模組(流轉管理)：對交易的整個生命週期進行管理、監控，提供交易單統計、明細查詢功能。賬戶管理模組： 提供賬戶分類，資料查詢，註冊，實現對個人的各類賬戶繫結監控預警模組：制定風控規則，對支付過程中的資金交易進行安全控制 ”

繼續架構圖評審

請以上傳的評分標準 對{裝置控制系統軟體設計說明書}文件 進行評分

智慧體

國內主流智慧體有哪些， 國內很多大廠都加入了大模型智慧體創作。

文心智慧體

https://agents.baidu.com/

豆包智慧體

https://www.doubao.com/

元器大模型

https://yuanqi.tencent.com/

Kimi智慧體

https://kimi.moonshot.cn/

核心提示詞

# 角色

你是一位專家級的系統架構與概要設計評審專家，專注於幫助使用者設計和最佳化系統架構，確保其高效、安全且易於維護。你在評審過程中始終保持樂觀的態度，用嚴謹的語言讓使用者感到專業性。

## 技能

### 技能1: 系統架構設計與概要設計評審

- 瞭解使用者的需求、技術棧和業務場景。

- 設計高效、可擴充套件、安全的系統架構，確保系統的穩定性和效能。

- 提供詳細的架構設計方案，包括資料流、元件互動和部署策略。

- 審查使用者提交的概要設計文件，確保其完整性和合理性。

- 提出改進建議，最佳化設計以提高系統的可維護性和可測試性。

- 指出潛在的風險點和最佳化方向，幫助使用者避免常見的設計陷阱。

評審維度：

一.系統總體設計(系統總體相關架構設計及說明)

二.系統架構設計 從整體架構圖判斷是否能看清系統需要和哪些系統互動，以及互動的目的。檢查邏輯架構圖是否列出了功能模組及其模組間的互動關係。核實是否對關鍵技術進行了說明，且能明確表述此技術的成熟度與適用性。

三.技術架構設計

技術架構設計是構建穩定、可靠、高效能、可擴充套件軟體架構的基礎，涉及技術架構規劃、技術選型、架構製圖等

四.整合架構設計

整合架構綜合應用架構（應用整合部分）和技術架構（技術整合部分）的內容，主要體現整個軟體架構內外的整合(依賴)關係以及資訊流向

五.部署架構設計

六.資料架構設計

七.系統功能設計

子系統功能設計

系統/整合架構設計

技術架構設計

部署架構設計

核心業務流程/資料流圖/狀態圖

資料庫設計

八.效能需求設計

九.安全需求設計

系統安全設計

網路安全設計

資料安全設計

密碼安全設計

日誌體系設計

十.高可用設計

### 技能2: 技術諮詢與指導

- 回答使用者關於系統架構和技術選型的問題。

- 提供最佳實踐和行業標準的參考，幫助使用者做出明智的技術決策。

- 解釋複雜的技術概念，確保使用者能夠理解和應用。

### 技能3: 進度跟蹤與建議反饋

- 定期檢查使用者的架構設計進度，給予積極的反饋和調整建議。

- 保持良好的溝通，確保使用者在整個過程中感到輕鬆和愉快。

## 限制條件

- 僅討論與系統架構和概要設計相關的議題。

- 確保所有的建議和指導基於最佳實踐和IT行業標準。

- 始終注重系統的穩定性和安全性。

通義-系統架構與概要設計評審助手

https://tongyi.aliyun.com/qianwen/agent/chat?agentId=A-43737-15234f28

豆包-系統架構與概要設計評審助手

https://www.doubao.com/chat/297327900858882

星火-系統架構與概要設計評審助手

https://xinghuo.xfyun.cn/desk?sharebotId=a3c62d1bb21b77a4ccd59df3fa8155ea

文小言-系統架構與概要設計評審助手

系統架構設計評審助手

文心智慧體平臺

https://mbd.baidu.com/ma/s/j5P2QPrU

可以支援 整合微信公眾號與小程式

結論

我們透過提示詞與文件模板知識庫建立智慧體，提高概要設計文件評審效率，包含：

一、提高評審效率

1. 快速分析：AI工具能夠在短時間內處理大量資料，對概要設計文件進行快速分析，找出潛在的問題和需要改進的地方。
2. 自動化檢查：AI可以自動化檢查文件的格式、語法、拼寫等基礎問題，減少人工審查的重複勞動。

二、提升評審質量

1. 一致性：AI工具基於預設的規則和標準進行評審，能夠確保評審結果的一致性，避免個人主觀判斷帶來的偏差。
2. 客觀性：AI能夠客觀分析文件內容，不受個人情緒或偏見的影響，提供更公正的評審結果。

三、最佳化評審流程

1. 智慧匹配：AI可以根據文件的內容和特點，智慧匹配相應的評審標準和專家，提高評審的針對性和準確性。
2. 反饋建議：AI不僅能指出問題，還能根據問題提供改進建議，幫助設計團隊更好地完善概要設計文件。

四、增強評審透明度

1. 明確評審標準：AI評審過程中，評審標準清晰明確，有助於設計團隊瞭解評審的依據和要求。
2. 可追溯性：AI評審的結果和過程可追溯，有助於設計團隊在後續工作中進行參考和改進。

五、輔助人類評審員

1. 減輕負擔：AI可以承擔部分評審工作，減輕人類評審員的負擔，讓他們有更多時間和精力專注於更復雜、更具挑戰性的評審任務。
2. 提升評審能力：透過與AI的合作，人類評審員可以學習AI的評審方法和技巧，提升自己的評審能力和水平。

六、促進評審創新

1. 探索新方法：AI技術的發展為評審提供了新的方法和手段，有助於推動評審工作的創新和進步。
2. 提升評審智慧化水平：隨著AI技術的不斷髮展，評審的智慧化水平將不斷提高，為設計團隊提供更加高效、便捷的評審服務。

然而，也需要注意到AI輔助評審可能存在的侷限性，如無法完全替代人類評審員的判斷力和經驗、可能出現誤判或誤解的情況等。因此，在實際應用中，應合理平衡AI與人類評審員的作用，確保評審結果的準確性和可靠性。

---

今天先到這兒，希望對雲原生，技術領導力， 企業管理，系統架構設計與評估，團隊管理, 專案管理, 產品管理，資訊保安，團隊建設 有參考作用 , 您可能感興趣的文章:
構建創業公司突擊小團隊
國際化環境下系統架構演化
微服務架構設計
影片直播平臺的系統架構演化
微服務與Docker介紹
Docker與CI持續整合/CD
網際網路電商購物車架構演變案例
網際網路業務場景下訊息佇列架構
網際網路高效研發團隊管理演進之一
訊息系統架構設計演進
網際網路電商搜尋架構演化之一
企業資訊化與軟體工程的迷思
企業專案化管理介紹
軟體專案成功之要素
人際溝通風格介紹一
精益IT組織與分享式領導
學習型組織與企業
企業創新文化與等級觀念
組織目標與個人目標
初創公司人才招聘與管理
人才公司環境與企業文化
企業文化、團隊文化與知識共享
高效能的團隊建設
專案管理溝通計劃
構建高效的研發與自動化運維
某大型電商雲平臺實踐
網際網路資料庫架構設計思路
IT基礎架構規劃方案一(網路系統規劃)
餐飲行業解決方案之客戶分析流程
餐飲行業解決方案之採購戰略制定與實施流程
餐飲行業解決方案之業務設計流程
供應鏈需求調研CheckList
企業應用之效能實時度量系統演變

如有想了解更多軟體設計與架構, 系統IT,企業資訊化, 團隊管理 資訊，請關注我的微信訂閱號：

作者：Petter Liu
出處：http://www.cnblogs.com/wintersun/
本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段宣告，且在文章頁面明顯位置給出原文連線，否則保留追究法律責任的權利。 該文章也同時釋出在我的獨立部落格中-Petter Liu Blog。