Skip to content

claude-code-quickstart.md

Latest commit

 

History

History
125 lines (85 loc) · 3.86 KB

claude-code-quickstart.md

File metadata and controls

125 lines (85 loc) · 3.86 KB

Claude Code 快速上手

5 分钟内把 ai-coding-ok 装进 Claude Code，并让它在你项目上立即生效。

✨ v2.0 新特性速览

  • 三种工作模式：Install / PDCA / Upgrade
  • PDCA 自动执行：任务开始前自动读记忆，结束后自动写记忆
  • 自动升级：输入 upgrade ai-coding-ok 即可升级框架文件

1. 安装 skill

Claude Code 会自动加载 ~/.claude/skills/ 下的每个 skill 目录，所以最省事的安装就是：

# macOS / Linux
git clone https://github.com/Mark7766/ai-coding-ok ~/.claude/skills/ai-coding-ok

# Windows (PowerShell)
git clone https://github.com/Mark7766/ai-coding-ok $env:USERPROFILE\.claude\skills\ai-coding-ok

或者走安装脚本（效果一样，但会排除 .git/）：

git clone https://github.com/Mark7766/ai-coding-ok
cd ai-coding-ok
bash install.sh --claude-code

2. 在你的项目里启用

cd your-project
claude           # 打开 Claude Code

在会话里说其中任意一句都行，Claude 会自动触发 skill：

  • /ai-coding-ok
  • "帮我装上 ai-coding-ok"
  • "给这个项目配上三层记忆系统"
  • "让 AI 跨会话不失忆"

3. 交互流程（长这样）

You:   /ai-coding-ok

Claude: 我要把 16 个模板文件拷到当前项目。检测到现在是一个空目录，没有冲突。
         开始拷贝... ✓
         现在请用一句话告诉我：你想做什么？

You:   一个给团队用的周报收集工具，每周五自动提醒提交，汇总后发邮件

Claude: 推断如下：
         - 项目名：team-weekly
         - 类型：内部效率工具
         - 技术栈：Python 3.12 + FastAPI + SQLite + Jinja2 + pytest
         - 设计原则：极简，部署简单 > 性能 > 扩展性
         - 核心流程：定时提醒 → 收集表单 → 周日汇总发邮件
         正在替换所有占位符... ✓
         记录为 ADR-001（SQLite 选型理由） + TASK-001（本次初始化）✓

         ✅ 全部就绪。建议打开 AGENTS.md 确认一下架构描述。

4. 验证

bash ~/.claude/skills/ai-coding-ok/scripts/verify.sh

应输出：

✓ All 16 required files are present.
✓ No unfilled placeholders — setup looks fully customized.

5. 从此刻起的工作方式

每次你给 Claude 新任务时，它都会自动：

  1. Plan：先读 AGENTS.md + .github/agent/memory/*.md，再出计划
  2. Do：按计划写代码 + 写测试
  3. Check：跑测试，看有没有回归
  4. Act：把这次任务写进 task-history.md；架构变了再动 decisions-log.md

💡 v2.0 起，PDCA 工作流是强制执行的 — AGENTS.md 和 copilot-instructions.md 顶部的强制指令块确保 AI 不会跳过这些步骤。你不需要手动提醒。

6. 常见问题

Q: 我的项目已经有 AGENTS.md 或 .github/，会不会被覆盖？ A: 不会。skill 发现冲突会停下来问你。安装脚本也默认 cp -n（不覆盖）。

Q: 我想升级到最新版 skill 怎么办？ A: 两步：

  1. 升级 skill 仓库：cd ~/.claude/skills/ai-coding-ok && git pull
  2. 升级项目框架文件：在项目里输入 upgrade ai-coding-ok，Claude 会自动合并框架更新并保留你的项目定制内容。

Q: 什么时候会自动触发 PDCA？（v2.0） A: 只要项目里有 .github/agent/memory/ 目录，任何开发任务都会自动触发：

  • 任务开始 → 自动执行 Mode B（读取记忆）
  • 任务结束 → 自动执行 Mode C（更新记忆）

Q: 我不想让 skill 自动读记忆怎么办？ A: 删掉 .github/agent/memory/ 即可，其余规则仍有效。

Q: 团队成员也要用，怎么办？ A: 让他们也 git clone 到 ~/.claude/skills/ai-coding-ok。项目里那份 .github/ 已经随 git 分享了，所以大家读到的是同一份记忆。