Skip to content

CLAUDE.md

Latest commit

 

History

History
301 lines (244 loc) · 12.6 KB

CLAUDE.md

File metadata and controls

301 lines (244 loc) · 12.6 KB
Raw

AI 技术学习模板 - 工作流程指南

项目概述

这是一个 AI 技术学习模板，一个可复用的 AI 驱动学习框架。Fork 后即可自定义学习内容，适合系统化学习任何技术领域。

学习目标

  • 掌握 AI 工具的核心功能和配置
  • 学习 MCP (Model Context Protocol) 协议
  • 了解 AI 编排和 Agent 配置
  • 积累实战项目经验

预计学习时长

  • 最小可行路径（P0 模块）：约 1 周
  • 核心能力路径（P0 + P1）：约 6-8 周
  • 全栈学习路径（全部模块）：约 10-14 周

项目结构

ai-learning-template/
├── .templates/                  # 系统模板目录（Git 追踪）
│   └── modules/                 # 课程内容模板
│       ├── 01-基础入门/         # 分类导学、模块 README、练习文件
│       ├── 02-进阶探索/         # 分类导学、模块 README、练习文件
│       └── 03-实战应用/         # 分类导学、模块 README、实战项目
├── 01-基础入门/                 # P0/P1 必学模块（由 init.sh 创建）
│   ├── ai-tools-fundamentals/   # P0 AI 工具基础
│   └── mcp-protocol/            # P1 MCP 协议入门
├── 02-进阶探索/                 # P1/P2 进阶模块（由 init.sh 创建）
│   ├── agent-configuration/     # P2 Agent 配置与使用
│   ├── mcp-advanced-config/     # P3 MCP 高级配置
│   ├── ai-orchestration/        # P1 AI 编排平台
│   └── ai-resources-research/   # P1 AI 资源研究
├── 03-实战应用/                 # P1/P2 实战模块（由 init.sh 创建）
│   ├── config-management/       # P2 配置管理工具
│   ├── spec-driven-dev/         # P2 规范驱动开发
│   └── practical-projects/      # P1 综合实战项目
├── PROGRESS.md                  # 总体进度追踪（个人数据，.gitignore）
├── LEARNING_BOOKMARKS.md        # 学习书签系统（个人数据，.gitignore）
├── KNOWLEDGE_CACHE.md           # 知识缓存状态（个人数据，.gitignore）
├── CLAUDE.md                    # 本文件 - AI 工作流程配置
└── README.md                    # 项目说明文档

架构说明（v3.0.0）

  • 系统内容：.templates/modules/ 包含所有课程内容、练习文件、实战项目
  • 用户目录：01-*/02-*/03-*/ 由 init.sh 创建，包含用户的个人进度和笔记
  • 数据隔离：用户可自由修改个人版本，同步上游时不会被覆盖

模块组织说明

  • 每个模块包含：README.md（从模板复制）、checklist.md（个人数据）、notes.md（个人数据）
  • 知识缓存存储在：模块名/knowledge/ 目录
  • 练习文件存储在：模块名/exercises/ 目录（从模板复制）

快速参考

进度管理

命令 功能 触发示例
查看学习状态 显示所有模块进度 "查看学习状态"、"我学哪了"、"进度如何"
更新进度 同步特定模块进度 "更新进度"、"记录进度"、"打勾"

学习管理

命令 功能 触发示例
开始学习 启动新模块学习 "开始学习"、"我要学..."、"进入..."
完成学习 标记模块完成 "学完了"、"搞定..."、"结束学习"
重置模块 清除模块进度 "重置模块"、"重新开始..."

书签系统

命令 功能 触发示例
创建书签 记录学习疑问 "创建书签"、"添加书签"、"记个书签"
继续书签 查看/继续探索书签 "继续书签"、"查看书签"、"我的书签"
完成书签 标记书签完成 "书签搞定了"、"书签学完了"、"结束书签"

知识缓存

命令 功能 触发示例
初始化缓存 创建模块知识缓存 "初始化缓存"、"创建缓存"、"拉取资料"
刷新缓存 更新知识缓存 "刷新缓存"、"更新缓存"、"同步资料"
查看缓存 显示缓存状态 "查看缓存"、"缓存状态"、"看看缓存"

同步管理（Fork 用户）

命令 功能 触发示例
检查更新 检查上游是否有新版本 "检查更新"、"有更新吗"、"模板有更新吗"
新增模块 添加新的学习模块 "新增模块"、"添加模块"、"创建模块"

GitHub 原生同步

Fork 用户推荐使用 GitHub 原生同步方式：

  1. GitHub UI：点击 "Sync fork" → "Update branch"
  2. 命令行：git fetch upstream && git merge upstream/main

个人数据保护：以下文件已被 .gitignore 保护，同步时不会被覆盖：

  • PROGRESS.md（学习进度）
  • LEARNING_BOOKMARKS.md（学习书签）
  • **/checklist.md（模块清单）
  • **/notes.md（学习笔记）
  • **/knowledge/（知识缓存）
  • **/README.md（课程内容，用户可自由修改）

学习系统架构

本模板采用 渐进式三技能架构，优化上下文使用和加载效率。

技能分层

Skill 类型 功能 触发关键词
learning-status 📌 常驻 查看状态、更新进度、共享机制 "查看学习状态"、"进度怎么样"、"更新进度"、"记录进度"
learning-manager ⏳ 按需 开始学习、完成学习、重置模块 "开始学习"、"我要学..."、"学完了"、"搞定"、"重置"
learning-tools ⏳ 按需 书签、缓存、同步、模块管理 "创建书签"、"初始化缓存"、"检查更新"、"新增模块"

架构优势

┌─────────────────────────────────────────────────────────┐
│  learning-status (常驻, ~200行)                          │
│  • 查看学习状态                                          │
│  • 更新模块进度                                          │
│  • 非阻塞更新检查（共享机制）                            │
│  • 模块路径映射（共享）                                  │
├─────────────────────────────────────────────────────────┤
│  learning-manager (按需加载, ~350行)                     │
│  • 开始学习（整合缓存检查）                              │
│  • 完成学习                                              │
│  • 重置模块                                              │
├─────────────────────────────────────────────────────────┤
│  learning-tools (按需加载, ~650行)                       │
│  • 书签管理（创建、继续、完成、删除）                    │
│  • 知识缓存（初始化、刷新、查看）                        │
│  • 同步管理（检查更新、同步计划、选择性同步）            │
│  • 模块管理（新增、更新、删除）                          │
└─────────────────────────────────────────────────────────┘

关键改进：

  • ✅ 最小常驻上下文：只有200行的 learning-status 常驻
  • ✅ 职责清晰：状态管理、生命周期、工具集三层分离
  • ✅ 按需加载：核心功能和高级功能独立加载
  • ✅ 消除重复：共享机制集中在一个技能中
  • ✅ 保持友好：自然语言触发体验不变

推荐工作流程

开始学习 (learning-manager)
    ↓
学习过程
    ├─ 查看进度 (learning-status)
    ├─ 创建书签 (learning-tools)
    └─ 查阅缓存 (learning-tools)
    ↓
完成学习 (learning-manager)
    ↓
检查更新 (learning-tools)

工作原理

当你说出相关关键词时，对应的 Skill 会自动加载并执行相关功能。这意味着：

  • 常驻技能（learning-status）始终可用，提供状态查询和共享机制
  • 按需技能（learning-manager、learning-tools）只在需要时加载
  • 仍然支持自然语言表达
  • 代码重复消除，维护成本降低

模块路径映射

新名称（v2.0）

  • ai-tools-fundamentals → 01-基础入门/ai-tools-fundamentals
  • mcp-protocol → 01-基础入门/mcp-protocol
  • agent-configuration → 02-进阶探索/agent-configuration
  • mcp-advanced-config → 02-进阶探索/mcp-advanced-config
  • ai-orchestration → 02-进阶探索/ai-orchestration
  • ai-resources-research → 02-进阶探索/ai-resources-research
  • config-management → 03-实战应用/config-management
  • spec-driven-dev → 03-实战应用/spec-driven-dev
  • practical-projects → 03-实战应用/practical-projects

旧名称（v1.x 向后兼容）

  • claude-code-core → 01-基础入门/claude-code-core
  • mcp-basics → 01-基础入门/mcp-basics
  • agent-sdk → 02-进阶探索/agent-sdk
  • mcp-advanced → 02-进阶探索/mcp-advanced
  • openclaw-ecosystem → 02-进阶探索/openclaw-ecosystem
  • everything-claude-code → 02-进阶探索/everything-claude-code
  • cc-switch → 03-实战应用/cc-switch
  • spec-kit → 03-实战应用/spec-kit
  • projects → 03-实战应用/projects

别名映射

当用户使用旧名称时，系统会自动提示并使用新名称：

旧名称 新名称 说明
claude-code-core ai-tools-fundamentals AI 工具基础
mcp-basics mcp-protocol MCP 协议入门
agent-sdk agent-configuration Agent 配置与使用
mcp-advanced mcp-advanced-config MCP 高级配置
openclaw-ecosystem ai-orchestration AI 编排平台
everything-claude-code ai-resources-research AI 资源研究
cc-switch config-management 配置管理工具
spec-kit spec-driven-dev 规范驱动开发
projects practical-projects 综合实战项目

输出格式规范

进度条

███░░░░░░░░ 30%
██████░░░░░ 60%
██████████░ 80%
████████████ 100%

状态徽章

  • 🟢 未开始
  • 🟡 进行中
  • ✅ 已完成

优先级标识

  • P0 🔴 必学
  • P1 🟠 推荐
  • P2 🟡 可选
  • P3 ⚪ 了解

模块状态卡片

┌────────────────────────────────────┐
│ ai-tools-fundamentals [P0🔴 必学] │
├────────────────────────────────────┤
│ 模式: 📚 快速模式                  │
│ 状态: 🟡 进行中                    │
│ 进度: █████░░░░░░░░░░░░ 25%        │
└────────────────────────────────────┘

常见问题

如何开始学习？

说 "开始学习 <模块名>" 或 "我要学 <模块名>" 即可启动学习流程。

如何查看进度？

说 "查看学习状态" 或 "我学哪了" 可查看所有模块进度。

如何更新进度？

说 "更新进度 <模块名>" 或 "记录进度" 可同步最新进度。

如何创建书签？

说 "创建书签 <名称>" 可在学习过程中记录疑问点。

如何检查模板更新？

说 "检查更新" 或 "有更新吗" 可查看上游是否有新版本。

技术架构

本模板采用 渐进式三技能架构：

Level 1: CLAUDE.md (本文件)
         ↓ 仅包含项目概述和快速参考

Level 2: Prompt Skills (分层加载)
         ├─ learning-status (常驻, ~200行)
         │  ↓ 查看状态、更新进度、共享机制
         ├─ learning-manager (按需, ~350行)
         │  ↓ 学习生命周期管理
         └─ learning-tools (按需, ~650行)
            ↓ 书签、缓存、同步、模块管理

Level 3: 详细流程文档
         ↓ 各 Skill 的完整执行步骤

v2.1 架构改进：

  • 整合前：5个技能，共1366行，代码重复严重
  • 整合后：3个技能，共1200行，共享机制集中
  • 常驻上下文：仅200行（learning-status）
  • 按需加载：1000行（learning-manager + learning-tools）

这种设计确保：

  • 常驻上下文保持精简（~200 行）
  • 复杂功能按需加载
  • 自然语言触发保持流畅
  • 代码重复消除，维护成本降低