关于 designing-systems
designing-systems 是用于记录系统架构和技术决策的设计技能,涵盖需求收集、绘图、权衡分析、风险审查,以及通过概念验证进行设计验证。
主要功能
- 01选择 ADR 或系统设计文档
- 02收集功能与非功能需求
- 03使用 Mermaid 绘制组件图
- 04定义数据模型与 API 契约
- 05审查权衡、风险并进行验证
适用场景
- 01规划新系统或组件
- 02记录技术选型的理由
- 03通过概念验证评估高风险组件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ dralgorhythm/ claude-agentic-framework --skill designing-systems安装后在 Claude Code 中输入/designing-systems确认已加载。
附带文件resources/adr.template.mdresources/system-design.template.md
详细介绍
系统设计
工件选择
- ADR (
./artifacts/adr_[topic].md,模板):一项决策——在多个备选方案中做出选择,并说明理由和后果。 - 系统设计文档 (
./artifacts/system_design_[component].md,模板):整个系统或组件——架构、数据模型、API、非功能性需求和分阶段计划。
新系统通常需要两者:系统设计文档用于说明整体方案,另为每项值得单独论证的决策编写一份 ADR(例如“为何选择 Postgres 而非 DynamoDB”)。
工作流
- 需求:收集功能性和非功能性需求
- 图表:起草 Mermaid 图,展示组件及其边界
- 数据与 API:定义数据模型、存储策略和接口契约
- 权衡:针对每项重大决策,以表格比较选项 A 与选项 B——优点、缺点和适用场景
- 风险:识别单点故障
- 技术策略:确认每项技术选择都符合
.claude/rules/tech-strategy.md——未经明确指示,不得偏离 - 编写文档:填写相应模板,并保存到
./artifacts/
设计验证循环
- 根据模板起草工件
- 与利益相关者审阅
- 针对风险最高的组件构建 POC
- 根据 POC 的发现完善设计
- 定稿工件
资源
评论
支持 Markdown