关于 likec4-architecture
用于创建和维护 LikeC4 软件架构模型的工作流技能,指导团队组织模型结构与视图,并通过 CLI 验证及预览或导出。
主要功能
- 01复用或初始化模型文件
- 02定义元素与关系
- 03创建聚焦的架构视图
- 04使用 LikeC4 CLI 验证模型
- 05提供预览和导出命令
适用场景
- 01为系统启动架构建模
- 02按领域或团队整理图表
- 03分享前验证架构变更
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ timseriakov/ likec4-architecture-skill --skill likec4-architecture安装后在 Claude Code 中输入/likec4-architecture确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdagents/openai.yamlassets/likec4-starter/docs/architecture/model.c4evaluations/create-new-model.jsonexport-artifacts.jsonupdate-existing-model.jsonreferences/examples.mdlikec4-capabilities-reference.mdlikec4-checklist.mdlikec4-dsl-quickstart.mdlikec4-patterns.mdscripts/bootstrap_likec4_starter.sh详细介绍
LikeC4 架构
在 LikeC4 中建模软件架构,保持其可执行,并返回经过验证的输出。
工作流
- 确定模型范围:
- 明确系统边界和受众。
- 除非用户另有要求,否则从上下文视图和容器视图开始。
- 查找模型文件:
- 如果已有
.c4/.likec4文件,则复用。 - 如果没有,则从
assets/likec4-starter/docs/architecture/model.c4启动。
- 先建模结构,再处理视觉呈现:
- 定义稳定的元素 ID 和有意义的名称。
- 添加明确的定向关系,并使用简短标签。
- 在适当处添加技术和描述字段。
- 保持视图聚焦:
- 构建小巧且目标明确的视图。
- 按领域、团队或限界上下文拆分拥挤的图表。
- 验证并打包:
- 运行
npx likec4 validate并修复所有错误。 - 提供
npx likec4 start预览命令。 - 如有要求,提供
build/export命令。
必要质量关卡
- 不要留下未标注且含义不明确的关系。
- 不要留下从未出现在视图中的孤立元素。
- 元素标题优先使用领域名称,而非实现细节。
- 只有在 CLI 验证成功后才能完成。
命令集
使用完成任务所需的最少命令:
npx likec4 validate
npx likec4 start
npx likec4 build -o ./dist
npx likec4 export png -o ./assets/architecture
输出约定
架构文件发生变更时,返回:
- 变更的文件。
- 验证结果。
- 每个视图的一句话用途说明。
- 与请求相关的预览/构建/导出命令。
资源
- CLI 和建模检查清单:
references/likec4-checklist.md - 入门模型模板:
assets/likec4-starter/docs/architecture/model.c4 - 启动辅助脚本:
scripts/bootstrap_likec4_starter.sh
评论
支持 Markdown