EventCatalog项目中增强领域语言定义：支持图片嵌入的技术实践

在领域驱动设计（DDD）实践中，统一语言（Ubiquitous Language）是团队沟通的核心基础。EventCatalog作为文档工具，近期在2.19.0版本中实现了对Markdown渲染和图片嵌入的支持，这为技术文档的视觉表达带来了重要升级。

技术背景与需求演进

传统技术文档中，纯文本定义往往难以完整传达复杂概念。特别是在描述领域模型时，示例图片能直观展示：

• 实体关系示意图
• 状态机流程图
• 业务场景示例图
• 系统交互时序图

早期版本中用户只能通过文字描述这些内容，新版本通过Markdown支持解决了这一表达瓶颈。

实现方案解析

核心改进包含两个层面：

1. Markdown渲染引擎集成
   在描述字段中完整支持CommonMark规范，包括：

   • 图片语法 ![alt text](path)
   • 代码块高亮
   • 表格渲染
   • 内联HTML（需安全过滤）

2. 静态资源管理策略
   推荐两种图片存储方案：

   • 项目内托管
     在/static目录建立images/definitions/子目录，使用相对路径引用

     ![订单状态机](./static/images/definitions/order-state.png)
     

   • CDN托管
     对高频访问资源建议使用云存储服务，但需注意：
     • 配置CORS策略
     • 启用HTTPS
     • 设置缓存头

最佳实践建议

1. 图片优化准则

   • SVG优先（适合架构图、流程图）
   • PNG用于需要透明底的截图
   • 使用<picture>标签响应式适配

2. 文档结构规范

   docs/
     definitions/
       payment.md  # 文字定义
     static/
       images/
         definitions/
           payment-flow.svg  # 配套图片
   

3. 版本控制策略
   图片资源应与文档同步版本化，建议：

   • 将大尺寸二进制文件纳入.gitignore
   • 使用Git LFS管理超过1MB的图片
   • 在changelog中注明图片变更

技术影响分析

这项改进使得：

• 领域专家能通过视觉元素更准确传递业务概念
• 减少文档维护者需要额外维护的"示例系统"
• 提升新成员理解复杂业务逻辑的效率
• 为未来可能的AR/VR文档形态奠定基础

对于采用EventCatalog的团队，建议在定义核心领域术语时，配套添加可视化素材形成完整的语义表达体系。在微服务架构下，这种图文结合的方式能有效降低跨团队的理解偏差。