AI导哈

事件风暴转事件目录转换器

将EventStorming输出自动转换为结构化EventCatalog文档的工具，适用于事件驱动架构的文档化。

  • by event-catalog
  • 本地部署
  • 更新于
在 GitHub 查看 event-catalog/eventstorm-to-catalog

使用说明

EventStorm到EventCatalog-MCP示例

使用EventCatalog MCP服务器将EventStorming输出转换为有文档记录的EventCatalog的实验项目。

这仍然是实验性的，正在进行中。在构建目录时，您可能会发现一些小问题。

这是什么？

此项目演示了如何将EventStorming输出自动转换为结构化的EventCatalog文档。EventStorming是一种用于探索复杂业务领域的协作研讨会技术，EventCatalog是一种针对事件驱动架构的文档工具，侧重于领域驱动设计。

先决条件

安装

为Claude Code安装EventCatalog MCP服务器：

claude mcp add --transport stdio eventcatalog -- npx @eventcatalog/mcp-server@latest https://demo.eventcatalog.dev {EVENTCATALOG_SCALE_LICENSE_KEY}

您可以免费获得EventCatalog Scale 来自EventCatalog网站的许可证密钥.

用法

  1. 在会话中配置EventCatalog MCP服务器（使用上面的命令）。
  2. 为您的活动风暴板拍照，或准备好活动风暴图像
  3. 打开Claude Code并导航到您的项目目录
  4. 参考您的Event Storm图像，并提示您的LLM将图像转换为EventCatalog：
Turn this photo of an Event Storming board into an EventCatalog.

Claude将分析您的事件风暴图像并自动生成：

  • 域定义
  • 服务文档
  • 事件定义
  • 命令定义
  • 流程文档
  • 组件之间的关系

示例

此存储库包括一个示例事件风暴会话(storm.jpg)显示了索赔处理工作流程，其中包括：

  • 命令（蓝色）：提交索赔、检查文件、检查保险等。
  • 事件（橙色）：提交索赔、登记索赔、完成付款等。
  • 总计（黄色）：索赔、评估、付款
  • 参与者（用户图标）：客户、管理员、索赔部门人员
  • 问题（粉红色）：政策管理背景问题

生成的EventCatalog文档可在 eventcatalog/ 目录。

事件目录结构

生成的EventCatalog遵循以下结构：

eventcatalog/
   domains/              # Domain definitions and subdomains
   services/            # Service documentation
   events/              # Event definitions
   commands/            # Command definitions
   flows/               # Business flow documentation
   eventcatalog.config.ts  # EventCatalog configuration

运行生成的EventCatalog

要查看生成的EventCatalog，请执行以下操作：

cd eventcatalog
npm install
npm run dev

然后打开浏览器查看交互式文档，网址为http://localhost:3000.

益处

  • 快速文档：将手动文档的小时数转换为分钟数
  • 一致性：生成的文档遵循EventCatalog标准
  • 协作：弥合研讨会会议和技术文件之间的差距
  • 迭代：随着事件风暴的发展，快速更新文档

了解更多

许可证

这是一个演示EventCatalog MCP功能的示例项目。

相关 MCP