project-to-obsidian

这段内容是审核时保存的快照。外部来源才是完整且最新的版本。

---
name: project-to-obsidian
description: |
  将代码项目转换为 Obsidian 知识库。当用户提到 obsidian、项目文档、知识库、分析项目、转换项目 时激活。

  【激活后必须执行】：
  1. 先完整阅读本 SKILL.md 文件
  2. 理解 AI 写入规则（默认到 00_Inbox/AI/、追加式、统一 Schema）
  3. 执行 STEP 0: 使用 AskUserQuestion 询问用户确认
  4. 用户确认后才开始 STEP 1 项目扫描
  5. 严格按 STEP 0 → 1 → 2 → 3 → 4 顺序执行

  【禁止行为】：
  - 禁止不读 SKILL.md 就开始分析项目
  - 禁止跳过 STEP 0 用户确认
  - 禁止直接在 30_Resources 创建（先到 00_Inbox/AI/）
  - 禁止自作主张决定输出位置
version: 1.4.0
author: Claude Code
---

# Project to Obsidian - 项目知识库生成器

将任意代码项目转换为结构化的 Obsidian 知识库，让项目知识可搜索、可链接、可扩展。

---

## 🎯 核心功能

| 命令 | 功能 | 说明 |
|------|------|------|
| `/p2o <项目路径>` | 完整转换 | 分析项目并生成完整 Obsidian 库 |
| `/p2o <路径> --quick` | 快速概览 | 只生成项目概览和结构 |
| `/p2o <路径> --api` | API 文档 | 专注生成 API/函数文档 |
| `/p2o <路径> --arch` | 架构文档 | 生成架构和设计文档 |

---

## ⚡ 执行流程

```
用户意图: "把这个项目转成知识库" / /p2o
              ↓
┌─────────────────────────────────────────────────────────┐
│  PHASE 0: 用户确认（必须）                                │
│                                                         │
│  Claude 使用 AskUserQuestion 工具询问：                   │
│                                                         │
│  "检测到你想将项目转换为 Obsidian 知识库，请确认："        │
│                                                         │
│  📁 项目路径: /path/to/project                           │
│                                                         │
│  选择输出方式：                                           │
│  [1] 写入 Obsidian vault（需要 MCP）                     │
│  [2] 创建本地文件夹                                       │
│  [3] 输出到项目 /docs 目录                                │
│  [4] 取消                                                │
│                                                         │
│  用户选择后才继续执行。                                    │
└─────────────────────────────────────────────────────────┘
              ↓
        用户确认后
              ↓
┌─────────────────────────────────────────────────────────┐
│  PHASE 1: 项目扫描                                       │
│  ├─ 读取项目结构 (Glob + Bash ls/find)                   │
│  ├─ 识别项目类型 (package.json/Cargo.toml/go.mod 等)     │
│  ├─ 检测主要语言和框架                                    │
│  └─ 生成文件清单                                         │
└─────────────────────────────────────────────────────────┘
              ↓
┌─────────────────────────────────────────────────────────┐
│  PHASE 2: 代码分析                                       │
│  ├─ 读取关键文件 (入口、配置、核心模块)                    │
│  ├─ 提取：                                               │
│  │   ├─ 函数/类/接口定义                                 │
│  │   ├─ API 端点                                        │
│  │   ├─ 依赖关系                                        │
│  │   ├─ 配置项                                          │
│  │   └─ 注释和文档字符串                                 │
│  └─ 构建代码知识图谱                                     │
└─────────────────────────────────────────────────────────┘
              ↓
┌─────────────────────────────────────────────────────────┐
│  PHASE 3: 文档生成                                       │
│  ├─ 生成 Obsidian 目录结构                               │
│  ├─ 创建各类文档：                                       │
│  │   ├─ 00-项目概览.md (MOC)                            │
│  │   ├─ 01-快速开始.md                                  │
│  │   ├─ 02-架构设计.md                                  │
│  │   ├─ 03-API文档/                                     │
│  │   ├─ 04-模块说明/                                    │
│  │   ├─ 05-配置参考.md                                  │
│  │   └─ 06-开发指南.md                                  │
│  └─ 添加双向链接 [[]] 和标签 #tag                        │
└─────────────────────────────────────────────────────────┘
              ↓
┌─────────────────────────────────────────────────────────┐
│  PHASE 4: 输出到 Obsidian                                │
│  ├─ 方式A: 写入 00_Inbox/AI/{{项目名}}/ (推荐，先落地)    │
│  ├─ 方式B: 写入 30_Resources/Projects/{{项目名}}/        │
│  └─ 方式C: 创建本地文件夹                                 │
└─────────────────────────────────────────────────────────┘
              ↓
         完成报告
```