一个现代化的软件架构知识库,融合经典理论与 AI 辅助建模技术,提供从理论学习到实践应用的完整解决方案。
- 🤖 AI 辅助建模: 结合大语言模型的现代化架构设计流程
- 📝 代码化图表: 基于 Mermaid 的版本控制友好的架构图表
- 🎯 实战导向: 3个不同领域的完整项目案例
- 👥 团队协作: 标准化的团队协作流程和工具链
- 📚 理论结合: 经典架构理论与现代实践的有机结合
深入学习软件架构的理论基础和经典方法论:
- 软件架构定义与核心概念
- 质量属性与架构权衡
- 架构师职责与技能要求
- C4 模型 - 现代架构可视化方法
- UML 统一建模语言 - 经典建模标准
- Kruchten 4+1 视图 - 多视角架构描述
- Rozanski & Woods 视图模型
- Views and Beyond 方法
- IEEE 42010 标准 - 架构描述国际标准
- ATAM & SAAM 方法 - 架构评估技术
- ADR 架构决策记录 - 决策文档化
- DDD 领域驱动设计 - 复杂业务建模
掌握 diagrams-as-code 的经典建模工具和方法:
- Mermaid - Markdown 集成的图表语法
- PlantUML - 强大的 UML 代码化工具
- Structurizr - C4 模型专用工具
- Prompts 模板库 - AI 辅助架构设计
- ADR 示例 - 决策记录最佳实践
- 自动化工具 - 提效工具集
推荐首选路线 - 掌握 LLM + Mermaid 的现代化架构建模方法:
- 完整实践指南 - 现代化建模流程总览
- 工作流程 (
workflows/
)- LLM 辅助建模流程 - AI 驱动的架构设计
- 需求到架构转换 - 系统化转换方法
- 团队协作指南 - 高效团队协作
- 图表模板 (
templates/
) - 5个核心 Mermaid 模板,覆盖90%的建模场景 - 实践示例 (
examples/
)
flowchart TD
A[业务需求] --> B[LLM 需求分析]
B --> C[架构方案生成]
C --> D[Mermaid 图表生成]
D --> E[团队协作评审]
E --> F[持续迭代优化]
F --> G[文档化与维护]
style A fill:#e3f2fd
style D fill:#e8f5e8
style G fill:#fff3e0
- Mermaid 工具 - 图表即代码
- PlantUML 工具 - 强大UML工具
- AI 提示词 - 智能辅助设计
- LLM 辅助: 利用大语言模型理解需求、生成架构
- 智能优化: AI 驱动的架构优化和最佳实践建议
- 自动化: 从需求到图表的自动化生成流程
- 版本控制: Mermaid 图表支持 Git 版本管理
- 易于维护: 文本格式,易于修改和更新
- 团队协作: 支持 Code Review 流程
- 真实案例: 3个不同领域的完整项目示例
- 最佳实践: 经过验证的架构模式和解决方案
- 端到端: 从需求分析到部署运维的完整覆盖
- 标准化: 统一的设计语言和工作流程
- 高效协作: 明确的角色分工和评审机制
- 知识传承: 系统化的经验总结和文档化
architecture-knowledge/
├── README.md # 项目总览
├── references.md # 参考文献和资源
├── practice/ # 🚀 现代化建模实践 (路线C)
│ ├── README.md # 实践指南总览
│ ├── workflows/ # 工作流程文档
│ │ ├── llm-assisted-modeling.md # LLM 辅助建模流程
│ │ ├── requirement-to-arch.md # 需求到架构转换
│ │ └── collaboration-guide.md # 团队协作指南
│ ├── templates/ # Mermaid 图表模板
│ │ ├── system-architecture.mmd # 系统架构模板
│ │ ├── component-diagram.mmd # 组件设计模板
│ │ ├── sequence-diagram.mmd # 时序图模板
│ │ ├── er-diagram.mmd # 数据模型模板
│ │ └── deployment-diagram.mmd # 部署架构模板
│ └── examples/ # 实践示例
│ ├── social-media-app/ # 社交媒体应用
│ ├── e-commerce-platform/ # 电商平台
│ └── iot-system/ # 物联网系统
├── theory/ # 架构理论体系 (路线A)
│ ├── 01-foundations/ # 架构基础
│ ├── 02-models/ # 建模方法
│ ├── 03-description/ # 描述标准
│ ├── 04-evaluation/ # 评估方法
│ ├── 05-decision-records/ # 决策记录
│ ├── 06-enterprise/ # 企业架构
│ └── 07-domain/ # 领域建模
└── modeling-workflow/ # 建模工具与工作流 (路线B)
├── mermaid/ # Mermaid 建模
├── plantuml/ # PlantUML 工具
├── structurizr/ # Structurizr 平台
├── prompts/ # AI 辅助 Prompts
├── adr-examples/ # ADR 示例
└── tools/ # 自动化工具
- 创建完整的 practice 目录体系
- 完成 LLM 辅助建模流程文档
- 建立需求到架构转换方法论
- 设计团队协作指南和流程
- 开发 5 个核心 Mermaid 模板
- 创建 3 个不同领域的完整示例
- 建立现代化建模最佳实践
- 创建知识库基础结构
- 完成 C4 模型理论文档
- 完成 Mermaid 工具指南
- 完成 AI Prompts 模板
- 完善 UML 实践案例
- 添加 PlantUML 教程
- 创建 ADR 示例库
- 完成 DDD 建模指南
- 添加 TOGAF 企业架构内容
- 文档总数: 20+ 篇专业文档
- 代码模板: 5 个标准化 Mermaid 模板
- 实践案例: 3 个完整项目示例
- 工作流程: 3 套标准化流程
- 预期效率提升: 70% 的设计时间节省
欢迎贡献内容和改进建议:
- Fork 本仓库
- 创建特性分支
- 提交您的改进
- 发起 Pull Request
本项目采用 MIT 许可证,详见 LICENSE 文件。
"使用 LLM 辅助建模流程后,我们团队的架构设计效率提升了 300%,从需求分析到初步架构设计从 1 周缩短到 1 天。"
—— 某互联网公司架构师
"标准化的模板和流程帮助我们建立了统一的设计语言,新团队成员上手速度显著提升。"
—— 某传统企业技术总监
"边缘计算项目的复杂架构通过这套方法论得到了很好的梳理和文档化。"
—— 某制造业 IoT 项目负责人
💡 推荐起点: 直接从 现代化建模实践 开始,体验 AI + Mermaid 的高效架构设计流程!