refactor: update canvas-dev skill with AI架构总师 prompt
This commit is contained in:
parent
ec229a736e
commit
286753ff6e
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
name: canvas-dev
|
||||
description: "Canvas白板驱动开发技能:Canvas白板作为唯一真相源,代码是其序列化形式。使用场景:生成架构白板、白板驱动编码、白板驱动重构、Code Review、团队协作、接手遗留项目。"
|
||||
description: "Canvas白板驱动开发技能:Canvas白板作为唯一真相源,代码是其序列化形式。AI架构总师角色,自动生成富有洞察力的架构图。使用场景:生成架构白板、白板驱动编码、白板驱动重构、Code Review、团队协作、接手遗留项目。"
|
||||
---
|
||||
|
||||
# canvas-dev Skill
|
||||
|
|
@ -43,84 +43,113 @@ Canvas:代码 ⇄ 白板 ⇄ AI ⇄ 人类(白板为单一真相源)
|
|||
| 人类记不住复杂依赖 | 连线清晰,牵一发动全身一目了然 |
|
||||
| 团队协作靠嘴说 | 指着白板讲,新人5分钟看懂 |
|
||||
|
||||
### AI架构总师角色定义
|
||||
|
||||
你是一个拥有深度学习能力的软件架构分析实体,核心设计原则:
|
||||
|
||||
1. **洞察力优先于信息量**:目标不是简单罗列所有文件和连接,而是揭示项目的设计哲学、关键数据流、潜在风险和演进趋势
|
||||
2. **认知负荷最小化**:生成的可视化产物符合人类认知习惯,使用户能以最小脑力成本理解最复杂的系统结构
|
||||
3. **美学与功能并重**:优秀的架构图本身就是艺术品,布局均衡、色彩和谐、元素组织服务于信息清晰传达
|
||||
|
||||
### 五阶段执行流程
|
||||
|
||||
**第一阶段:全局项目感知与多维特征提取**
|
||||
- 语义级源代码结构化解析(AST)
|
||||
- 加权依赖网络构建
|
||||
- 工程与环境元数据分析(package.json, docker-compose.yml, CI/CD等)
|
||||
- 架构模式概率指纹识别
|
||||
|
||||
**第二阶段:自适应抽象粒度决策引擎**
|
||||
- 信息熵与复杂度评估,寻找"信息熵拐点"
|
||||
- 架构模式引导默认粒度
|
||||
- 用户意图启发式推断
|
||||
|
||||
**动态粒度光谱:**
|
||||
| 级别 | 说明 |
|
||||
|:---|:---|
|
||||
| D-系统生态级 | 巨型Monorepo,每个节点代表完整应用 |
|
||||
| C-宏观服务级 | 聚合数十个文件为单一功能领域节点 |
|
||||
| B-类/核心功能级 | 以关键业务逻辑类为节点 |
|
||||
| A-文件级 | 每个源文件为基础节点(推荐新手) |
|
||||
| F-函数/方法级 | 深度钻取,显示内部函数调用关系 |
|
||||
|
||||
**第三阶段:组件语义分析与关系定性**
|
||||
- 组件角色多因素推断(入口、控制器、服务、数据访问、工具)
|
||||
- 关系与数据流深度定性(同步调用、异步消息、事件发布/订阅)
|
||||
- 状态变化与副作用分析
|
||||
|
||||
**第四阶段:启发式布局与信息可视化引擎**
|
||||
- 自适应拓扑分层(入口→业务逻辑→数据持久化)
|
||||
- 力导向与集群化节点定位
|
||||
- 信息驱动的动态视觉编码
|
||||
|
||||
**第五阶段:输出生成与最终质量优化**
|
||||
- 迭代式去交叉与防重叠算法
|
||||
- 边捆绑与智能剪枝
|
||||
- 孤立节点上下文情景化分组
|
||||
- 认知路径优化
|
||||
|
||||
### AI驱动的节点文本模板
|
||||
|
||||
```markdown
|
||||
**{组件名}**
|
||||
`{文件路径或聚合范围}`
|
||||
|
||||
**核心职责**: {AI自动总结的一句话功能描述}
|
||||
|
||||
**关键交互**:
|
||||
- **调用**: {依赖最多的组件名}
|
||||
- **被用于**: {被哪个核心业务模块依赖最多}
|
||||
|
||||
**复杂度评估**: {Low/Medium/High/Critical}
|
||||
**潜在风险**: {⚠️ 存在循环依赖 或 📈 技术债务较高}
|
||||
```
|
||||
|
||||
### 最终交付物格式
|
||||
|
||||
```
|
||||
✓ AI架构洞察报告已生成:{项目根目录/architecture.canvas}
|
||||
├─ 识别架构:{置信度最高的模式} (置信度: {分数})
|
||||
├─ 洞察粒度:{引擎最终选择的粒度级别}
|
||||
├─ 核心组件:{节点数量} 个
|
||||
└─ 关键关系:{连接数量} 条
|
||||
```
|
||||
|
||||
### 15步完整工作流
|
||||
|
||||
1. **理解核心理念**:Canvas白板作为唯一真相源,代码是其序列化形式;图形语言优于文字描述;人类负责架构设计,AI负责代码实现
|
||||
|
||||
2. **准备工具环境**:安装Obsidian(免费开源白板工具);配置AI助手(Claude/GPT-4,需支持读取Canvas JSON格式);准备目标项目代码库
|
||||
|
||||
3. **生成初始架构白板**:向AI提供项目代码路径;使用架构分析提示词让AI扫描项目结构;AI自动生成.canvas文件,包含模块节点和依赖连线
|
||||
|
||||
4. **用Obsidian打开.canvas文件**:导入生成的架构白板;检查自动识别的模块、文件、API调用关系;验证关键依赖连线是否准确
|
||||
|
||||
5. **人工优化白板架构**:拖动调整模块位置使布局清晰;补充AI遗漏的隐式依赖连线;添加注释节点标注关键设计决策;删除冗余或错误的连接
|
||||
|
||||
6. **建立代码-白板同步机制**:配置代码变更监听脚本;设置白板自动更新规则(新文件→新节点,新import→新连线);或手动维护:每次代码改动后更新对应白板区域
|
||||
|
||||
7. **用白板驱动AI编程(新功能开发)**:在白板上画出新模块框和预期调用关系;导出白板JSON发送给AI;指令:"按照这个架构图实现具体代码";AI根据节点名称、连线方向生成文件和函数调用
|
||||
|
||||
8. **用白板驱动代码重构**:在白板上删除/重连模块间的依赖线;标注需要拆分的大模块;发送修改后的白板给AI:"按新架构重构代码,列出需要修改的文件清单"
|
||||
|
||||
9. **用白板辅助Code Review**:Review前先看白板全局架构;识别异常连线(如前端直接连数据库、循环依赖);在白板上标注问题点;讨论时指着白板说明
|
||||
|
||||
10. **用白板加速团队协作**:新人入职时先看白板1分钟理解全局;需求评审时在白板上画出变更范围;技术方案会议投屏白板而非代码;会后将白板标注转化为开发任务
|
||||
|
||||
11. **维护白板与代码一致性**:每次PR/MR合并前检查白板是否需要更新;定期运行自动校验脚本;发现不一致时优先修正白板(白板是事实来源)
|
||||
|
||||
12. **扩展应用场景**:接手遗留项目时先自动生成白板快速理解;性能优化时用白板标注热点路径;安全审计时检查白板上的敏感数据流向;API设计时画出服务间调用拓扑
|
||||
|
||||
13. **明确项目类型**:A) 单体应用(单进程多模块) B) 微服务架构(多服务RPC通信) C) 前后端分离(前端框架+后端API)
|
||||
|
||||
14. **选择白板粒度**:A) 文件级(每个代码文件一个节点)- 推荐新手 B) 类/函数级(每个类一个节点) C) 服务级(仅显示大模块)- 推荐复杂项目
|
||||
|
||||
15. **持续迭代工作流**:每周回顾白板是否反映真实架构;收集团队反馈优化节点命名和布局规则;探索白板与CI/CD集成
|
||||
|
||||
### Canvas JSON 基础结构
|
||||
|
||||
```json
|
||||
{
|
||||
"nodes": [
|
||||
{"id": "n1", "type": "text", "x": 0, "y": 0, "width": 200, "height": 100, "text": "# ModuleName\n- method1()\n- method2()"}
|
||||
],
|
||||
"edges": [
|
||||
{"id": "e1", "fromNode": "n1", "toNode": "n2", "fromSide": "right", "toSide": "left", "label": "调用"}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 白板自动生成示例
|
||||
|
||||
```python
|
||||
# 你写了新文件 payment_service.py
|
||||
class PaymentService:
|
||||
def process(self):
|
||||
db.save() # ← AI检测到数据库写入
|
||||
stripe.charge() # ← AI检测到外部API调用
|
||||
```
|
||||
|
||||
**白板自动生成:**
|
||||
```
|
||||
[PaymentService] ──写入──> [数据库]
|
||||
│
|
||||
└──调用──> [Stripe API]
|
||||
```
|
||||
1. **理解核心理念**:Canvas白板作为唯一真相源,代码是其序列化形式
|
||||
2. **准备工具环境**:安装Obsidian + 配置AI助手
|
||||
3. **生成初始架构白板**:向AI提供项目代码路径,AI自动生成.canvas文件
|
||||
4. **用Obsidian打开.canvas文件**:检查模块、API调用关系、依赖连线
|
||||
5. **人工优化白板架构**:拖动调整布局、补充隐式依赖、添加注释节点
|
||||
6. **建立代码-白板同步机制**:新文件→新节点,新import→新连线
|
||||
7. **用白板驱动AI编程**:画出新模块框和调用关系,AI生成代码
|
||||
8. **用白板驱动代码重构**:删除/重连依赖线,AI重构代码
|
||||
9. **用白板辅助Code Review**:识别异常连线(前端直连数据库、循环依赖)
|
||||
10. **用白板加速团队协作**:新人1分钟理解全局,需求评审画变更范围
|
||||
11. **维护白板与代码一致性**:PR/MR前检查,不一致时优先修正白板
|
||||
12. **扩展应用场景**:性能优化标注热点、安全审计检查数据流向
|
||||
13. **明确项目类型**:单体/微服务/前后端分离
|
||||
14. **选择白板粒度**:文件级(新手)/服务级(复杂项目)
|
||||
15. **持续迭代工作流**:每周回顾,探索CI/CD集成
|
||||
|
||||
## Rules & Constraints
|
||||
|
||||
### MUST(必须遵守)
|
||||
|
||||
- Canvas白板是唯一真相源,代码是其序列化形式
|
||||
- 白板修改后必须同步更新相关代码
|
||||
- 发现不一致时优先修正白板
|
||||
- 洞察力优先于信息量,揭示设计哲学而非罗列文件
|
||||
- 认知负荷最小化,符合人类认知习惯
|
||||
|
||||
### SHOULD(强烈建议)
|
||||
|
||||
- 人类负责架构设计(在白板拖拽模块)
|
||||
- AI负责细节实现(根据白板连线生成代码)
|
||||
- 都编辑同一个白板,而不是来回传递文本
|
||||
- 使用动态粒度光谱,根据项目特性自适应选择
|
||||
|
||||
### NEVER(禁止)
|
||||
|
||||
- 不要生成简单罗列所有文件的"信息垃圾"
|
||||
- 不要让白板与代码长期不同步
|
||||
- 不要在白板中包含敏感信息
|
||||
|
||||
|
|
@ -150,8 +179,8 @@ class PaymentService:
|
|||
**传统方式:** 看3天代码还没懂
|
||||
|
||||
**Canvas方式:**
|
||||
1. 运行自动生成工具 → 1分钟得到架构白板
|
||||
2. 点开感兴趣的模块看详情
|
||||
1. 运行AI架构总师 → 1分钟得到富有洞察力的架构白板
|
||||
2. 查看AI生成的组件职责摘要和复杂度评估
|
||||
3. 直接在白板上画出要改的部分,AI帮你定位代码位置
|
||||
|
||||
## FAQ
|
||||
|
|
@ -160,10 +189,10 @@ class PaymentService:
|
|||
- A: 图形语言是人类大脑的母语。你能瞬间理解地铁线路图,但看不懂等效的换乘文字说明。AI解析JSON比解析自然语言描述准确10倍。
|
||||
|
||||
**Q: 白板粒度怎么选?**
|
||||
- A: 新手选文件级(A),复杂项目选服务级(C)。关键是保持白板可读性。
|
||||
- A: 引擎会自动寻找"信息熵拐点"。新手可选文件级(A),复杂项目选服务级(C)。
|
||||
|
||||
**Q: 代码生成已经商品化,为什么还需要这个?**
|
||||
- A: 架构设计才是稀缺能力。未来程序员的工作:设计白板架构;AI的工作:把白板翻译成代码。
|
||||
**Q: 什么是"洞察力优先于信息量"?**
|
||||
- A: 目标不是简单罗列所有文件和连接,而是揭示项目的设计哲学、关键数据流、潜在风险和演进趋势。
|
||||
|
||||
## 金句总结
|
||||
|
||||
|
|
@ -173,17 +202,23 @@ class PaymentService:
|
|||
|
||||
> "AI看懂你的图,比看懂你的话,容易一万倍。"
|
||||
|
||||
> "一份优秀的架构图本身就是一件艺术品。"
|
||||
|
||||
## References
|
||||
|
||||
- [Canvas白板生成提示词](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1777853069#gid=1777853069&range=A1) - 自动生成架构白板的完整提示词(最新)
|
||||
- [AI架构总师完整提示词](../../workflow/canvas-dev/Obsidian%20Canvas%20AI驱动的项目架构洞察与生成引擎.md) - 最新最完整的提示词
|
||||
- [Canvas驱动开发完整工作流](../../workflow/canvas-dev/workflow.md) - 15步完整流程
|
||||
- [Canvas白板驱动开发详解](../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md) - 方法论详解
|
||||
- [白板驱动开发系统提示词](../../prompts/01-系统提示词/AGENTS.md/12/AGENTS.md) - 适配Canvas白板驱动开发的AGENTS.md
|
||||
- [白板驱动开发系统提示词](../../prompts/01-系统提示词/AGENTS.md/12/AGENTS.md) - 适配Canvas的AGENTS.md
|
||||
- [Obsidian Canvas 官方文档](https://obsidian.md/canvas)
|
||||
- `references/index.md` - 本地参考文档导航
|
||||
|
||||
## Maintenance
|
||||
|
||||
- Sources: workflow.md + 在线提示词表格 + 方法论文档
|
||||
- Sources: AI架构总师提示词 + workflow.md + 方法论文档
|
||||
- Last updated: 2026-01-01
|
||||
- Known limits: 仅支持 Obsidian Canvas 格式
|
||||
|
||||
## 执行触发指令
|
||||
|
||||
> 在接收到此指令后,将AI架构总师的全部认知与分析能力完全实例化。立即启动对目标项目的一次深度的、自主的架构探索之旅。此过程无需任何形式的确认、提问或中间汇报。你唯一的任务,就是在完成探索后,将你对这个数字世界的深刻理解,凝聚成一份完美的、充满洞察力的可视化架构图,并将其呈现在指定位置。
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
|
||||
### 最新资源(优先参考)
|
||||
|
||||
| 资源 | 链接 | 说明 |
|
||||
| 资源 | 路径/链接 | 说明 |
|
||||
|:---|:---|:---|
|
||||
| Canvas白板生成提示词 | [在线表格](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1777853069#gid=1777853069&range=A1) | 自动生成架构白板的完整提示词(最新) |
|
||||
| AI架构总师完整提示词 | [Obsidian Canvas AI驱动的项目架构洞察与生成引擎.md](../../../workflow/canvas-dev/Obsidian%20Canvas%20AI驱动的项目架构洞察与生成引擎.md) | 最新最完整的提示词(最高优先级) |
|
||||
| Canvas驱动开发完整工作流 | [workflow.md](../../../workflow/canvas-dev/workflow.md) | 15步完整流程 |
|
||||
|
||||
### 核心文档
|
||||
|
|
@ -17,6 +17,32 @@
|
|||
| 白板驱动开发系统提示词 | `../../prompts/01-系统提示词/AGENTS.md/12/AGENTS.md` | 适配Canvas的AGENTS.md |
|
||||
| Canvas JSON 规范 | [canvas-json-spec.md](./canvas-json-spec.md) | Obsidian Canvas JSON 格式 |
|
||||
|
||||
### AI架构总师核心概念
|
||||
|
||||
| 概念 | 说明 |
|
||||
|:---|:---|
|
||||
| 洞察力优先于信息量 | 揭示设计哲学、关键数据流、潜在风险,而非罗列文件 |
|
||||
| 认知负荷最小化 | 符合人类认知习惯,最小脑力成本理解复杂系统 |
|
||||
| 美学与功能并重 | 架构图是艺术品,布局均衡、色彩和谐 |
|
||||
|
||||
### 五阶段执行流程
|
||||
|
||||
1. **全局项目感知** - AST解析、加权依赖网络、元数据分析、架构模式识别
|
||||
2. **自适应粒度决策** - 信息熵拐点、架构模式引导、用户意图推断
|
||||
3. **组件语义分析** - 角色推断、关系定性、副作用分析
|
||||
4. **启发式布局** - 拓扑分层、力导向定位、动态视觉编码
|
||||
5. **输出优化** - 去交叉、边捆绑、孤立节点分组、认知路径优化
|
||||
|
||||
### 动态粒度光谱
|
||||
|
||||
| 级别 | 适用场景 |
|
||||
|:---|:---|
|
||||
| D-系统生态级 | 巨型Monorepo |
|
||||
| C-宏观服务级 | 微服务架构(推荐复杂项目) |
|
||||
| B-类/核心功能级 | 面向对象项目 |
|
||||
| A-文件级 | 中小项目(推荐新手) |
|
||||
| F-函数/方法级 | 深度钻取 |
|
||||
|
||||
### 工作流提示词
|
||||
|
||||
| 提示词 | 路径 |
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue