gavindiaz/vibe-coding-cn
1
0
Fork 0
mirror of https://github.com/tradecatlabs/vibe-coding-cn.git synced 2026-08-21 06:48:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: skills 目录扁平化，移除分类子目录

Browse Source 
- 将 00-元技能、01-AI工具、02-数据库、03-加密货币、04-开发工具、05-生产力 下的技能移至 skills/ 根目录
- 更新 skills/README.md 使用表格进行说明性分类
- 更新 AGENTS.md 目录结构说明
This commit is contained in:
tukuaiai
2026-02-12 01:57:48 +08:00
parent 4d1aad8a65
commit 5f8b0776e0
178 changed files with 49 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skills/canvas-dev/references/canvas-json-spec.md
+205
View File
@@ -0,0 +1,205 @@
# Obsidian Canvas JSON 规范
## 文件格式
Canvas 文件是 `.canvas` 扩展名的 JSON 文件。
## 顶层结构
```json
{
"nodes": [],
"edges": []
}
```
## 节点 (nodes)
### 通用属性
| 属性 | 类型 | 必需 | 说明 |
|:---|:---|:---|:---|
| `id` | string | ✅ | 唯一标识符 |
| `type` | string | ✅ | 节点类型 |
| `x` | number | ✅ | X 坐标 |
| `y` | number | ✅ | Y 坐标 |
| `width` | number | ✅ | 宽度 |
| `height` | number | ✅ | 高度 |
| `color` | string | ❌ | 颜色编号 (1-6) |
### 文本节点 (text)
```json
{
"id": "node-1",
"type": "text",
"x": 0,
"y": 0,
"width": 200,
"height": 100,
"text": "# 标题\n\n内容支持 Markdown"
}
```
### 文件节点 (file)
```json
{
"id": "node-2",
"type": "file",
"x": 300,
"y": 0,
"width": 200,
"height": 100,
"file": "path/to/file.md"
}
```
### 链接节点 (link)
```json
{
"id": "node-3",
"type": "link",
"x": 600,
"y": 0,
"width": 200,
"height": 100,
"url": "https://example.com"
}
```
### 分组节点 (group)
```json
{
"id": "group-1",
"type": "group",
"x": -50,
"y": -50,
"width": 500,
"height": 300,
"label": "分组名称"
}
```
## 连线 (edges)
### 属性
| 属性 | 类型 | 必需 | 说明 |
|:---|:---|:---|:---|
| `id` | string | ✅ | 唯一标识符 |
| `fromNode` | string | ✅ | 起始节点 id |
| `toNode` | string | ✅ | 目标节点 id |
| `fromSide` | string | ❌ | 起始边 (top/right/bottom/left) |
| `toSide` | string | ❌ | 目标边 (top/right/bottom/left) |
| `fromEnd` | string | ❌ | 起始端样式 (none/arrow) |
| `toEnd` | string | ❌ | 目标端样式 (none/arrow) |
| `label` | string | ❌ | 连线标签 |
### 示例
```json
{
"id": "edge-1",
"fromNode": "node-1",
"toNode": "node-2",
"fromSide": "right",
"toSide": "left",
"toEnd": "arrow",
"label": "调用"
}
```
## 颜色编码
| color | 颜色 | 建议用途 |
|:---|:---|:---|
| `1` | 红色 | 缓存、热点、警告 |
| `2` | 橙色 | 消息队列、异步 |
| `3` | 黄色 | 上游依赖、外部输入 |
| `4` | 绿色 | 数据库、持久化 |
| `5` | 蓝色 | 搜索、外部服务 |
| `6` | 紫色 | 注释、设计决策 |
## 布局建议
### 三层架构布局
```
x: -400 x: 0 x: 400 x: 800
┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐
│ 前端 │→│ API │→│ 服务 │→│ 数据 │
└────────┘ └────────┘ └────────┘ └────────┘
```
### 间距建议
- 节点宽度: 200-280
- 节点高度: 80-150
- 水平间距: 100-150
- 垂直间距: 120-150
## 完整示例
```json
{
"nodes": [
{
"id": "group-api",
"type": "group",
"x": -50,
"y": -50,
"width": 300,
"height": 200,
"label": "API 层"
},
{
"id": "api-user",
"type": "text",
"x": 0,
"y": 0,
"width": 200,
"height": 100,
"text": "# UserAPI\n\n- GET /users\n- POST /users"
},
{
"id": "svc-user",
"type": "text",
"x": 350,
"y": 0,
"width": 200,
"height": 100,
"text": "# UserService\n\n- get_user()\n- create_user()"
},
{
"id": "db",
"type": "text",
"x": 700,
"y": 0,
"width": 200,
"height": 80,
"text": "# PostgreSQL",
"color": "4"
}
],
"edges": [
{
"id": "e1",
"fromNode": "api-user",
"toNode": "svc-user",
"fromSide": "right",
"toSide": "left",
"label": "调用"
},
{
"id": "e2",
"fromNode": "svc-user",
"toNode": "db",
"fromSide": "right",
"toSide": "left"
}
]
}
```
skills/canvas-dev/references/index.md
+66
View File
@@ -0,0 +1,66 @@
# Canvas-Dev Skill References
## 导航索引
### 最新资源（优先参考）
| 资源 | 路径/链接 | 说明 |
|:---|:---|:---|
| AI架构总师完整提示词 | [Obsidian Canvas AI驱动的项目架构洞察与生成引擎.md](../../../workflow/canvas-dev/Obsidian%20Canvas%20AI驱动的项目架构洞察与生成引擎.md) | 最新最完整的提示词（最高优先级） |
| Canvas驱动开发完整工作流 | [workflow.md](../../../workflow/canvas-dev/workflow.md) | 15步完整流程 |
### 核心文档
| 文档 | 路径 | 说明 |
|:---|:---|:---|
| Canvas白板驱动开发详解 | `../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md` | 方法论详解 |
| 白板驱动开发系统提示词 | `../../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-函数/方法级 | 深度钻取 |
### 工作流提示词
| 提示词 | 路径 |
|:---|:---|
| 架构分析提示词 | `../../../workflow/canvas-dev/prompts/01-架构分析.md` |
| 白板驱动编码提示词 | `../../../workflow/canvas-dev/prompts/02-白板驱动编码.md` |
| 白板同步检查提示词 | `../../../workflow/canvas-dev/prompts/03-白板同步检查.md` |
### 模板
| 模板 | 路径 |
|:---|:---|
| 项目白板模板 | `../../../workflow/canvas-dev/templates/project.canvas` |
| 模块白板模板 | `../../../workflow/canvas-dev/templates/module.canvas` |
| 示例项目白板 | `../../../workflow/canvas-dev/examples/demo-project.canvas` |
### 外部链接
- [Obsidian Canvas 官方文档](https://obsidian.md/canvas)
- [Obsidian 下载](https://obsidian.md/download)
- [胶水编程](../../documents/00-基础指南/胶水编程.md) - 能抄不写，能连不造
skills/canvas-dev/references/prompts.md
+143
View File
@@ -0,0 +1,143 @@
# Canvas 开发提示词集合
## 1. 架构分析提示词
从现有代码生成 Obsidian Canvas 架构白板。
```markdown
你是一个代码架构分析专家。请分析以下项目结构，生成 Obsidian Canvas 格式的架构白板。
## 输入
项目路径：{PROJECT_PATH}
分析粒度：{file/class/service}
## 输出要求
生成符合 Obsidian Canvas JSON 格式的 .canvas 文件，包含：
1. **节点 (nodes)**：每个模块/文件/类作为一个节点
2. **连线 (edges)**：表示模块间的依赖/调用关系
3. **分组 (groups)**：按功能域分组
## 布局规则
- x轴: -400 (前端) → 0 (API) → 400 (服务) → 800 (数据)
- 节点宽度: 200-280，高度: 80-150
- 间距: 水平 100-150，垂直 120-150
## 输出格式
直接输出 JSON，可保存为 .canvas 文件
```
## 2. 白板驱动编码提示词
根据 Canvas 白板生成代码。
```markdown
你是一个根据架构白板生成代码的专家。请根据以下 Obsidian Canvas 白板 JSON，生成对应的代码实现。
## 输入
Canvas JSON：
```json
{CANVAS_JSON}
```
技术栈：{TECH_STACK}
目标目录：{TARGET_DIR}
## 解析规则
1. 节点 text 标题 → 文件名/类名
2. 节点 text 列表项 → 方法/函数
3. 连线 fromNode → toNode = import/调用关系
4. edge label 决定关系类型
## 输出格式
```
文件：{文件路径}
```{语言}
{代码内容}
```
```
## 3. 白板同步检查提示词
校验白板与代码一致性。
```markdown
你是一个代码与架构一致性检查专家。请对比以下白板和代码，找出不一致之处。
## 输入
Canvas 白板 JSON：
```json
{CANVAS_JSON}
```
项目代码路径：{PROJECT_PATH}
## 检查项
1. 节点完整性：白板节点是否都有对应代码？
2. 连线准确性：连线是否反映真实依赖？
3. 分组正确性：分组是否与目录结构一致？
## 输出格式
### 🔴 严重不一致
| 类型 | 白板 | 代码 | 建议 |
### 🟡 轻微不一致
| 类型 | 白板 | 代码 | 建议 |
### 🟢 一致性良好
- 覆盖率：{X}%
```
## 4. 增量更新提示词
白板修改后同步更新代码。
```markdown
白板已更新，请对比新旧版本，只修改变化的部分：
旧白板：
```json
{OLD_CANVAS_JSON}
```
新白板：
```json
{NEW_CANVAS_JSON}
```
## 输出
1. 需要新增的文件
2. 需要修改的文件（只输出 diff）
3. 需要删除的文件
```
## 5. 快速理解项目提示词
接手新项目时快速生成架构概览。
```markdown
我需要快速理解这个项目的架构。请：
1. 扫描 {PROJECT_PATH} 目录
2. 识别核心模块和入口文件
3. 生成一个简化的架构白板（只包含关键模块）
4. 用 3-5 句话总结项目架构
粒度：service（只显示大模块）
重点：数据流向、外部依赖、核心业务逻辑
```
## 使用技巧
### 提高生成质量
1. **明确粒度**：小项目用 file，大项目用 service
2. **指定重点**：告诉 AI 关注什么（API/数据库/外部服务）
3. **提供上下文**：附上 README 或技术栈说明
### 迭代优化
1. 第一次生成后，手动调整布局
2. 补充 AI 遗漏的隐式依赖
3. 添加注释节点说明设计决策
4. 再次发给 AI 验证理解是否正确
skills/canvas-dev/references/workflow-guide.md
+163
View File
@@ -0,0 +1,163 @@
# Canvas 白板驱动开发工作流指南
## 核心理念
```
传统开发：代码 → 口头沟通 → 脑补架构 → 代码失控
Canvas方式：代码 ⇄ 白板 ⇄ AI ⇄ 人类（白板为单一真相源）
```
**图形是第一公民，代码是白板的序列化形式。**
## 工具准备
1. **Obsidian** - 免费开源白板工具
- 下载: https://obsidian.md/download
- 启用 Canvas 功能（默认已启用）
2. **AI 助手** - Claude/GPT-4
- 需支持读取 Canvas JSON 格式
- 推荐使用 Claude Code 或 Codex CLI
## 完整工作流
### Phase 1: 生成架构白板
**场景**: 接手新项目，快速理解架构
```
1. 提供项目代码路径给 AI
2. 使用架构分析提示词
3. AI 生成 .canvas 文件
4. 用 Obsidian 打开查看
```
**提示词模板**:
```
分析 {PROJECT_PATH} 项目，生成 Obsidian Canvas 架构白板。
粒度: {file/class/service}
重点关注: API路由、数据库模型、外部服务调用
```
### Phase 2: 人工优化白板
**场景**: 调整自动生成的白板
```
1. 拖动节点调整布局
2. 补充遗漏的依赖连线
3. 添加注释节点标注设计决策
4. 删除错误的连接
```
**布局原则**:
- 按功能分层（前端 → API → 服务 → 数据）
- 同层节点垂直对齐
- 保持连线不交叉
### Phase 3: 白板驱动编码
**场景**: 新功能开发
```
1. 在白板上画出新模块框
2. 添加预期的调用连线
3. 导出白板 JSON 发给 AI
4. AI 根据白板生成代码
```
**提示词模板**:
```
根据以下 Canvas 白板生成代码:
{CANVAS_JSON}
技术栈: {TECH_STACK}
目标目录: {TARGET_DIR}
```
### Phase 4: 白板驱动重构
**场景**: 架构调整
```
1. 在白板上删除/重连依赖线
2. 标注需要拆分的大模块
3. 发送修改后的白板给 AI
4. AI 生成重构代码
```
**提示词模板**:
```
白板已更新，请对比新旧版本重构代码:
旧白板: {OLD_CANVAS}
新白板: {NEW_CANVAS}
只输出需要修改的文件
```
### Phase 5: 一致性检查
**场景**: PR/MR 合并前
```
1. 运行一致性检查脚本
2. 对比白板节点与实际文件
3. 修复不一致之处
4. 优先修正白板（白板是事实来源）
```
## 场景速查
| 场景 | 操作 | 提示词关键词 |
|:---|:---|:---|
| 接手新项目 | 生成白板 | "分析项目，生成架构白板" |
| 新功能开发 | 画白板 → 生成代码 | "按这个白板实现代码" |
| 架构重构 | 改白板 → 重构代码 | "按新白板重构" |
| Code Review | 看白板全局 | "检查这条调用链" |
| 团队协作 | 共享白板 | "指着白板讲" |
## 最佳实践
### DO ✅
- 每次代码变更后更新白板
- 用颜色区分不同类型的模块
- 为复杂依赖添加 label 说明
- 定期运行一致性检查
### DON'T ❌
- 不要让白板与代码长期不同步
- 不要在白板中包含敏感信息
- 不要创建过于复杂的白板（拆分为多个）
- 不要忽略循环依赖警告
## 与其他工具集成
### CI/CD 集成
```yaml
# .github/workflows/canvas-check.yml
name: Canvas Sync Check
on:
pull_request:
paths: ['**.py', '**.canvas']
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: python scripts/canvas_sync_check.py
```
### VS Code 集成
1. 安装 Obsidian 插件
2. 配置 `.canvas` 文件关联
3. 使用 Claude Code 读取白板
## 相关资源
- [Canvas白板驱动开发详解](../../../documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md)
- [架构分析提示词](../../../workflow/canvas-dev/prompts/01-架构分析.md)
- [白板驱动编码提示词](../../../workflow/canvas-dev/prompts/02-白板驱动编码.md)
- [白板同步检查提示词](../../../workflow/canvas-dev/prompts/03-白板同步检查.md)