mcpField
A
architecture-diagrams

architecture-diagrams

github.com/aj-geddes开发3732.0k 次安装34 周前更新
代码仓库

关于 architecture-diagrams

这项技能借助 Mermaid 和 PlantUML 创建易维护的代码化架构图，适用于系统设计与技术文档，涵盖数据流、组件关系和部署等主题。

主要功能

  1. 01Mermaid 与 PlantUML 图表指导
  2. 02系统与基础设施架构图
  3. 03C4、时序与组件图
  4. 04数据流与部署图
  5. 05图表规范与维护实践

适用场景

  1. 01记录系统架构与微服务
  2. 02呈现数据流与集成关系
  3. 03说明部署与基础设施
  4. 04可视化数据库模式和组件关系

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill architecture-diagrams

安装后在 Claude Code 中输入/architecture-diagrams确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
c4-context-diagram.md
class-diagram.md
component-diagram-2.md
component-diagram.md
data-flow-diagram.md
deployment-diagram-2.md
deployment-diagram.md
sequence-diagram.md
system-architecture-diagram.md
scripts/
validate-schema.sh
templates/
migration-template.sql

详细介绍

架构图

目录

概述

使用 Mermaid 和 PlantUML 等基于代码的图表工具，创建清晰、易于维护的架构图，用于系统设计、数据流和技术文档。

适用场景

  • 系统架构文档
  • C4 模型图
  • 数据流图
  • 时序图
  • 组件关系
  • 部署图
  • 基础设施架构
  • 微服务架构
  • 数据库模式（可视化）
  • 集成模式

快速开始

最简可运行示例：

graph TB
    subgraph "Client Layer"
        Web[Web App]
        Mobile[Mobile App]
        CLI[CLI Tool]
    end

    subgraph "API Gateway Layer"
        Gateway[API Gateway<br/>Rate Limiting<br/>Authentication]
    end

    subgraph "Service Layer"
        Auth[Auth Service]
        User[User Service]
        Order[Order Service]
        Payment[Payment Service]
        Notification[Notification Service]
    end

    subgraph "Data Layer"
        UserDB[(User DB<br/>PostgreSQL)]
        OrderDB[(Order DB<br/>PostgreSQL)]
        Cache[(Redis Cache)]
        Queue[Message Queue<br/>RabbitMQ]
    end
// ... (see reference guides for full implementation)

参考指南

references/ 目录中的详细实现：

指南内容
系统架构图系统架构图
时序图时序图
C4 上下文图C4 上下文图
组件图组件图
部署图部署图
数据流图数据流图
类图类图
组件图组件图
部署图部署图

最佳实践

✅ 应该
  • 使用一致的符号和标记
  • 为复杂图表添加图例
  • 让图表聚焦于一个方面
  • 有意义地使用颜色编码
  • 添加标题和说明
  • 对图表进行版本控制
  • 使用基于文本的格式（Mermaid、PlantUML）
  • 清晰地展示数据流向
  • 包含部署详情
  • 记录图表规范
  • 确保图表与代码保持同步
  • 使用子图进行逻辑分组
❌ 不应该
  • 在图表中塞入过多细节
  • 使用不一致的样式
  • 省略图表图例
  • 只创建二进制图像文件
  • 忘记记录关系
  • 在一张图中混合不同的抽象层级
  • 使用专有格式

评论

支持 Markdown