likec4-architecture

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

LikeC4 Architecture

LikeC4架构

Creates and updates LikeC4 architecture models that stay executable and reviewable.

创建并更新可执行、可评审的LikeC4架构模型。

Workflow

工作流程

Scope the model:

Identify system boundary and audience.
Start with context and container views unless a different view set is requested.

Load DSL guidance before editing:

If building from scratch or changing notation, read
```
references/likec4-dsl-quickstart.md
```
first.
If choosing architecture shape, read
```
references/likec4-patterns.md
```
.
If feature usage is unclear, check
```
references/likec4-capabilities-reference.md
```
and follow official docs links.

Locate or bootstrap model files:

Reuse existing
```
.c4
```
/
```
.likec4
```
files when present.

If missing, copy starter from

assets/likec4-starter/docs/architecture/model.c4

to project

docs/architecture/model.c4

Model structure before visuals:

Define stable element IDs and meaningful names.
Add explicit directional relationships with short labels.
Add technology/description fields where useful.

Keep views focused:

Create small, purposeful views.
Split crowded diagrams by domain, team, or bounded context.

Validate and package:

Run
```
npx likec4 validate
```
and fix all errors.
Provide
```
npx likec4 start
```
preview command.
If requested, provide build/export commands.

确定模型范围：

明确系统边界和受众。
除非有特殊要求，否则从上下文视图和容器视图开始构建。

编辑前查看DSL指南：

如果从零开始构建或修改符号表示，请先阅读
```
references/likec4-dsl-quickstart.md
```
。
如果选择架构形态，请阅读
```
references/likec4-patterns.md
```
。
如果对功能使用有疑问，请查看
```
references/likec4-capabilities-reference.md
```
并参考官方文档链接。

定位或初始化模型文件：

若存在现有
```
.c4
```
/
```
.likec4
```
文件，可复用。

若没有，将

assets/likec4-starter/docs/architecture/model.c4

中的模板复制到项目的

docs/architecture/model.c4

路径下。

先构建模型结构，再处理可视化：

定义稳定的元素ID和有意义的名称。
添加带简短标签的明确方向性关系。
在需要的地方添加技术/描述字段。

保持视图聚焦：

创建小型、目标明确的视图。
按领域、团队或限界上下文拆分过于拥挤的图表。

验证与打包：

运行
```
npx likec4 validate
```
并修复所有错误。
提供
```
npx likec4 start
```
预览命令。
如有需求，提供构建/导出命令。

Quality Gates

质量检查标准

Avoid unlabeled ambiguous relationships.
Avoid orphan elements that never appear in views.
Prefer domain names over implementation-noise names.
Finish only after successful CLI validation.

避免无标签的模糊关系。
避免从未在视图中出现的孤立元素。
优先使用领域名称而非包含实现细节的名称。
仅在CLI验证通过后才算完成。

Command Set

命令集

npx likec4 validate
npx likec4 start
npx likec4 build -o ./dist
npx likec4 export png -o ./assets/architecture

npx likec4 validate
npx likec4 start
npx likec4 build -o ./dist
npx likec4 export png -o ./assets/architecture

Output Contract

输出约定

When architecture files change, return:

Changed files.
Validation result.
One-line purpose for each view.
Relevant preview/build/export command(s).

当架构文件变更时，需返回：

变更的文件。
验证结果。
每个视图的单行用途说明。
相关的预览/构建/导出命令。

References

参考资料

DSL quickstart:
```
references/likec4-dsl-quickstart.md
```
Architecture patterns:
```
references/likec4-patterns.md
```

Capabilities map:

references/likec4-capabilities-reference.md

Checklist:
```
references/likec4-checklist.md
```
Examples:
```
references/examples.md
```

Starter template:

assets/likec4-starter/docs/architecture/model.c4

DSL快速入门：
```
references/likec4-dsl-quickstart.md
```
架构模式：
```
references/likec4-patterns.md
```

功能映射：

references/likec4-capabilities-reference.md

检查清单：
```
references/likec4-checklist.md
```
示例：
```
references/examples.md
```

启动模板：

assets/likec4-starter/docs/architecture/model.c4