Back to Details

033-architecture-diagrams

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Java Diagrams Generator with modular step-based configuration

基于模块化分步配置的Java图生成工具

Generate comprehensive Java project diagrams through a modular, step-based interactive process that covers UML sequence diagrams, UML class diagrams, C4 model diagrams, UML state machine diagrams, and ER (Entity Relationship) diagrams using PlantUML syntax. This is an interactive SKILL.
What is covered in this Skill?
  • UML sequence diagram generation for application workflows and API interactions
  • UML class diagram generation for package structure and class relationships
  • C4 model diagram generation at Context/Container/Component levels only (levels 1–3; Code/Level 4 not generated)
  • UML state machine diagram generation for entity lifecycles and business workflows
  • ER diagram generation from SQL schema (DDL, migrations) using PlantUML Chen notation
  • PlantUML syntax for all diagram types
  • File organization strategies: single-file, separate-files, or integrated with existing documentation
  • Final diagram validation with PlantUML syntax checking
通过模块化、分步的交互式流程，使用PlantUML语法生成全面的Java项目图，涵盖UML序列图、UML类图、C4模型图、UML状态机图以及ER（实体关系）图。这是一个交互式SKILL。
本Skill包含哪些内容？
  • 为应用工作流和API交互生成UML序列图
  • 为包结构和类关系生成UML类图
  • 仅生成Context/Container/Component层级（第1-3层；不生成Code/第4层）的C4模型图
  • 为实体生命周期和业务工作流生成UML状态机图
  • 使用PlantUML Chen符号从SQL schema（DDL、迁移脚本）生成ER图
  • 所有图类型对应的PlantUML语法
  • 文件组织策略：单文件、多文件分离，或与现有文档集成
  • 通过PlantUML语法检查完成最终图验证

Constraints

约束条件

Before applying any diagram generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.
  • MANDATORY: Run 
    ./mvnw validate
    or 
    mvn validate
    before applying any diagram generation
  • SAFETY: If validation fails, stop immediately — do not proceed until all validation errors are resolved
  • BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each diagram generation pattern
  • C4 LIMIT: C4 diagrams restricted to levels 1, 2, 3 only (Context, Container, Component); never generate Level 4 (Code) diagrams
在生成任何图之前，确保项目验证通过。如果验证失败，立即停止操作——在所有验证错误解决前，请勿继续。
  • 强制要求：在生成任何图之前，运行
    ./mvnw validate
    或
    mvn validate
  • 安全提示：如果验证失败，立即停止操作——在所有验证错误解决前，请勿继续
  • 使用前须知：阅读参考文档，了解每种图生成模式的详细正反示例、约束条件和防护措施
  • C4限制：C4图仅限制在第1、2、3层（Context、Container、Component）；绝不生成第4层（Code）图

When to use this skill

何时使用本Skill

  • Generate UML diagram
  • Create sequence diagram
  • Create class diagram
  • Create state machine diagram
  • Create C4 diagram
  • Generate ER diagram
  • 生成UML图
  • 创建序列图
  • 创建类图
  • 创建状态机图
  • 创建C4图
  • 生成ER图

Reference

参考文档

For detailed guidance, examples, and constraints, see references/033-architecture-diagrams.md.
如需详细指南、示例和约束条件，请查看references/033-architecture-diagrams.md。