Skip to content

Commit 1dd4525

Browse files
committed
feat: add architecture design skill
1 parent 8a5420b commit 1dd4525

11 files changed

Lines changed: 379 additions & 31 deletions

‎content/duplication-inventory.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"schemaVersion": "ControlContentDuplicationInventoryV1",
3-
"sourceBundleDigest": "06780bcd32d7d141b52faefaf0847486b1ae3a5e4d246c4d56481fc01d80e974",
3+
"sourceBundleDigest": "b557b296f7e928130cc92a4d21b5f1f98f1396696ca1b59672fd85e5af7e8e5b",
44
"thresholds": {
55
"minParagraphChars": 100,
66
"sectionThreshold": 0.94,

‎content/manifest.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"schemaVersion": "ControlContentManifestV1",
33
"sourceRoot": "content",
44
"sharedRoot": "shared",
5-
"expectedMarkdownEntries": 136,
5+
"expectedMarkdownEntries": 137,
66
"selectors": [
77
{
88
"source": "instructions.md",
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
name: architecture-design
3+
description: 架构设计文档编排 Owner — 当用户要求架构设计、系统设计、技术架构或可指导开发、Review 与任务拆分的完整方案时使用;要求从业务流程反推节点、状态、数据、一致性、异常补偿、ADR 与实施任务。
4+
---
5+
6+
# Architecture Design Skill
7+
8+
## 目录导航
9+
10+
- [定位](#定位)
11+
- [触发条件](#触发条件)
12+
- [与领域架构 Skill 的关系](#与领域架构-skill-的关系)
13+
- [核心门禁](#核心门禁)
14+
- [执行流程](#执行流程)
15+
- [输出结构](#输出结构)
16+
- [图表要求](#图表要求)
17+
- [反模式](#反模式)
18+
- [完成判定](#完成判定)
19+
20+
## 定位
21+
22+
本 Skill 负责完整架构设计文档的编排 Owner 视角。它把需求、业务流程、模块边界、数据模型、API 契约、一致性、异常补偿、ADR、验证与任务拆分组织成可直接指导开发、Review 和排期的设计产物。
23+
24+
本 Skill 不替代领域架构 Skill 的专业判断。它负责结构、顺序、追踪关系和交付物完整性;领域细节由后端、前端、数据、API、分布式、集成、平台、AI Agent、隐私合规、设计系统、DX 等 Skill 提供判断。
25+
26+
## 触发条件
27+
28+
| 场景 | 是否触发 |
29+
|------|:--------:|
30+
| 用户要求架构设计、系统设计、技术架构、概要设计、详细设计或可指导开发/Review/任务拆分的方案 | 必须 |
31+
| 需求从 0 到 1、跨模块、跨角色、跨状态、跨数据流或跨外部系统 | 必须 |
32+
| 方案需要主流程、子流程、节点设计、状态机、数据流、时序、ADR、风险和实施拆分 | 必须 |
33+
| 已有代码小修、单点 bug 修复、纯审计结论或只要求某一领域专家判断 | N/A + skipReason |
34+
35+
## 与领域架构 Skill 的关系
36+
37+
| 领域 | 主要协作 Skill | 本 Skill 的编排责任 |
38+
|------|----------------|--------------------|
39+
| 业务与产品取舍 | `product-strategy` | 把业务目标、角色、对象和成功标准转成架构输入 |
40+
| 后端领域与流程 | `backend-domain-architecture` | 确保业务不变量、权限、事务和幂等映射到节点设计 |
41+
| API 与公开契约 | `api-contract-architecture` | 确保 API 由流程和消费者反推,避免先写接口后补业务 |
42+
| 数据模型与迁移 | `data-architecture` | 确保模型、查询、索引、生命周期和消费者闭环 |
43+
| 前端体验 | `frontend-architecture`、`ux-interaction-architecture` | 确保状态、错误、加载、权限和交互与主流程一致 |
44+
| 分布式与外部系统 | `distributed-systems-architecture`、`external-integration-architecture` | 确保失败、重试、补偿、超时和一致性边界可验证 |
45+
| 平台、AI、合规与 DX | `platform-ecosystem-architecture`、`ai-agent-system-architecture`、`privacy-compliance-architecture`、`developer-experience-architecture` | 确保平台扩展、Agent 合同、合规边界和开发体验进入设计 |
46+
47+
## 核心门禁
48+
49+
| Gate | 要求 | 证据 |
50+
|------|------|------|
51+
| `ArchitectureDesignIntentGate` | 先结构化需求目标、业务场景、角色、业务对象、边界和非目标 | requirementMatrix、boundary |
52+
| `BusinessFlowFirstGate` | 先写主业务流程,再进入模块、类、表、API 或缓存 | mainFlow |
53+
| `FlowDecompositionGate` | 复杂主流程节点必须拆成子流程,并说明触发、输入、输出和终止条件 | subFlows |
54+
| `NodeImplementationGate` | 关键节点必须写职责、前置条件、读写数据、状态变化、依赖、成功/失败和幂等 | nodeDesign |
55+
| `StateMachineGate` | 有状态对象必须写状态、事件、转移条件、终态和非法转移 | stateMachine |
56+
| `DataFlowSequenceGate` | 数据流和时序必须说明谁产生、谁消费、何时持久化、何时可见 | dataFlow、sequence |
57+
| `ModuleBoundaryGate` | 模块职责、依赖方向、共享契约和禁止跨层访问必须清楚 | moduleMap |
58+
| `DataModelConsistencyGate` | 数据模型、唯一键、索引、事务、一致性、缓存和生命周期必须闭环 | dataModel、consistency |
59+
| `ApiContractMappingGate` | API/CLI/事件/Hook/MCP 契约必须由流程节点和消费者反推 | contractMatrix |
60+
| `FailureCompensationGate` | 重试、超时、重复提交、部分成功、外部失败和人工修复路径必须定义 | failureMatrix |
61+
| `ArchitectureDecisionGate` | 关键决策必须写问题、方案、理由、备选项、拒绝原因和代价 | ADR |
62+
| `DevelopmentTaskSplitGate` | 最终任务拆分必须能映射回流程节点、模块、契约和验证项 | taskBreakdown |
63+
| `ArchitectureReviewChecklistGate` | Review 清单必须覆盖流程、状态、数据、契约、一致性、异常、可运维性和风险 | checklist |
64+
65+
## 执行流程
66+
67+
1. 结构化意图:提取目标、用户价值、业务角色、核心对象、范围、非目标、约束和待确认项。
68+
2. 建立主流程:用业务语言描述从触发到终态的主路径,先不落实现类名和数据库表。
69+
3. 拆分子流程:对复杂节点补子流程,明确入口、出口、失败分支和可恢复路径。
70+
4. 设计节点:逐个关键节点写职责、输入、输出、前置条件、状态变化、数据读写、外部依赖、成功/失败和幂等策略。
71+
5. 路由领域 Skill:按实际问题调用相关领域架构 Skill,引用其判断而不是重复发明领域规则。
72+
6. 建模与契约:在流程和节点稳定后,定义模块、数据模型、API/事件/CLI/Hook/MCP 契约和兼容策略。
73+
7. 写 ADR:记录会影响扩展性、复杂度、成本、风险或长期维护的关键决策。
74+
8. 完成落地:输出验证策略、风险、待确认项、任务拆分和 Architecture Review Checklist。
75+
76+
## 输出结构
77+
78+
架构设计文档必须包含 `## 目录导航`。若某节不适用,保留标题并写明 `N/A + skipReason`;不要删除结构导致 Review 无法定位缺口。
79+
80+
```markdown
81+
## 目录导航
82+
## 1. 架构目标与成功标准
83+
## 2. 需求理解与业务场景
84+
## 3. 角色、权限与核心业务对象
85+
## 4. 系统边界与非目标
86+
## 5. 当前上下文与约束
87+
## 6. 整体架构图
88+
## 7. 系统主流程
89+
## 8. 子流程设计
90+
## 9. 核心节点详细设计
91+
## 10. 状态机设计
92+
## 11. 数据流设计
93+
## 12. 时序设计
94+
## 13. 模块架构与依赖方向
95+
## 14. 数据模型、索引与生命周期
96+
## 15. API、事件、CLI、Hook 或 MCP 契约
97+
## 16. 一致性、事务、缓存与幂等
98+
## 17. 异常、重试、补偿与人工修复
99+
## 18. 权限、安全、隐私与审计
100+
## 19. 性能、容量与可扩展性
101+
## 20. 可观测性与运维策略
102+
## 21. ADR 决策记录
103+
## 22. 风险、取舍与待确认项
104+
## 23. 开发任务拆分与里程碑
105+
## 24. Architecture Review Checklist
106+
```
107+
108+
## 图表要求
109+
110+
- 主流程优先使用 Mermaid `flowchart TD`,节点名称使用业务动作。
111+
- 有状态对象时使用 `stateDiagram-v2` 或状态转移表,必须包含非法转移处理。
112+
- 跨系统调用、异步事件、补偿和回调使用 `sequenceDiagram` 或时序表。
113+
- 图表必须和正文节点编号互相引用;不要为了形式完整添加无信息量图表。
114+
115+
## 反模式
116+
117+
| 反模式 | 修正 |
118+
|--------|------|
119+
| 从需求直接跳到 controller/service/repository/table/API | 先补主流程、子流程和节点设计 |
120+
| 只说“使用 Redis/MQ/定时任务/缓存”但不说明业务触发与失败恢复 | 补 ADR、数据可见性、一致性和补偿策略 |
121+
| 流程图只有大框,没有关键节点的输入、输出、状态和数据读写 | 补 `NodeImplementationGate` |
122+
| API 先行,业务流程和消费者后补 | 用 `ApiContractMappingGate` 反推契约 |
123+
| 写“根据实际情况处理异常” | 明确失败矩阵、重试边界、人工修复和告警 |
124+
| 为了显得完整引入不必要的分布式组件 | 写取舍,证明必要性或删除该复杂度 |
125+
126+
## 完成判定
127+
128+
完成的架构设计必须回答:做什么、为什么做、谁参与、主流程怎么走、关键节点怎么实现、状态如何变化、数据如何流动、契约如何消费、失败如何恢复、一致性如何保证、替代方案为何不选、开发任务如何拆分、Review 如何验收。
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"schemaVersion": "SkillIntentV1",
3+
"skillId": "architecture-design",
4+
"intents": [
5+
{
6+
"id": "primary",
7+
"label": "架构设计文档编排",
8+
"include": [
9+
"ADR",
10+
"Review",
11+
"system-design",
12+
"任务拆分",
13+
"技术架构",
14+
"架构设计",
15+
"概要设计",
16+
"系统设计"
17+
]
18+
}
19+
],
20+
"examples": {
21+
"positive": [
22+
"架构设计文档编排领域任务",
23+
"架构设计文档编排专项审查"
24+
],
25+
"negative": [
26+
"无关闲聊或通用问答",
27+
"由其他领域 Skill 明确负责的任务"
28+
]
29+
},
30+
"summary": "架构设计文档编排 Owner — 当用户要求架构设计、系统设计、技术架构或可指导开发、Review 与任务拆分的完整方案时使用;要求从业务流程反推节点、状态、数据、一致性、异常补偿、ADR 与实施任务。"
31+
}

‎content/skills/portfolio-evidence.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@
2424
}
2525
},
2626
"skills": {
27+
"architecture-design": {
28+
"triggerTerms": ["架构设计", "系统设计", "技术架构", "概要设计", "详细设计", "ADR", "任务拆分", "system-design"],
29+
"triggerPositive": [
30+
{ "fixture": "architecture-design-complete-doc", "input": "输出一份可以指导后续开发、Review 和任务拆分的完整架构设计文档" },
31+
{ "fixture": "architecture-design-system-plan", "input": "为这个新模块做系统设计,先从业务流程和状态机开始,再拆 API、数据模型和实施任务" },
32+
{ "fixture": "architecture-design-adr", "input": "这个方案需要补技术架构、ADR、异常补偿和一致性设计" }
33+
],
34+
"triggerNegative": [
35+
{ "fixture": "architecture-design-single-bug", "input": "这个按钮点击报错,直接修复" },
36+
{ "fixture": "architecture-design-audit-only", "input": "只审查当前技术方案有哪些问题,不要输出新的架构设计" }
37+
],
38+
"stateRationale": "registered architecture design orchestration skill with semantic positive/negative routing examples",
39+
"promotionCriteria": "expand measured trigger precision after enough real architecture-design WorkUnits are available"
40+
},
2741
"intent": {
2842
"triggerTerms": ["意图", "三问", "resume", "workflowIntent"],
2943
"triggerPositive": [

0 commit comments

Comments
 (0)