catlog22/Claude-Code-Workflow
1
0
Fork 0
mirror of https://github.com/catlog22/Claude-Code-Workflow.git synced 2026-03-01 15:03:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add VitePress documentation site

Browse Source 
- Add docs directory with VitePress configuration
- Add GitHub Actions workflow for docs build and deploy
- Support bilingual (English/Chinese) documentation
- Include search, custom theme, and responsive design
This commit is contained in:
catlog22
2026-02-28 16:14:09 +08:00
parent ab65caec45
commit c3ddf7e322
136 changed files with 34486 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
docs/zh/guide/ch01-what-is-claude-dms3.md Normal file
View File

@@ -0,0 +1,87 @@
# Claude_dms3 是什么
## 一句话定位
**Claude_dms3 是 VS Code 的 AI 辅助开发工作台** — 通过语义代码索引、多模型 CLI 调用和团队协作系统，让 AI 深度理解项目并按规范生成高质量代码。
> AI 能力如藤蔓般生长 — Claude_dms3 是引导 AI 沿着您的项目架构、编码规范和团队工作流前行的支架。
---
## 1.1 解决的痛点
| 痛点 | 现状 | Claude_dms3 方案 |
|------|------|------------------|
| **AI 不理解项目** | 每次新会话都要重新解释项目背景、技术栈和编码规范 | Memory 系统持久化项目上下文，AI 跨会话记住项目知识 |
| **代码搜索困难** | 关键词搜索找不到语义相关代码，不知道函数在哪里被调用 | CodexLens 语义索引，支持自然语言搜索和调用链追踪 |
| **单模型局限** | 只能调用一个 AI 模型，不同模型擅长的场景不同 | CCW 统一调用框架，支持多模型协作（Gemini、Qwen、Codex、Claude） |
| **协作流程混乱** | 团队成员各自为战，代码风格不一致，规范难以落地 | 团队工作流系统（PlanEx、IterDev、Lifecycle）确保规范执行 |
| **规范难落地** | CLAUDE.md 写了但 AI 不遵守，项目约束被忽略 | Spec + Hook 自动注入，AI 强制遵循项目规范 |
---
## 1.2 vs 传统方式对比
| 维度 | 传统 AI 助手 | **Claude_dms3** |
|------|-------------|-----------------|
| **代码搜索** | 文本关键词搜索 | **语义向量搜索 + LSP 调用链** |
| **AI 调用** | 单一模型固定调用 | **多模型协作，按任务选择最优模型** |
| **项目记忆** | 每次会话重新解释 | **跨会话持久化 Memory** |
| **规范执行** | 依赖 Prompt 提醒 | **Spec + Hook 自动注入** |
| **团队协作** | 各自为战 | **结构化工作流系统** |
| **代码质量** | 取决于 AI 能力 | **多维度审查 + 自动修复循环** |
---
## 1.3 核心概念速览
| 概念 | 说明 | 位置/命令 |
|------|------|----------|
| **CodexLens** | 语义代码索引和搜索引擎 | `ccw search` |
| **CCW** | 统一 CLI 工具调用框架 | `ccw cli` |
| **Memory** | 跨会话知识持久化 | `ccw memory` |
| **Spec** | 项目规范和约束系统 | `.workflow/specs/` |
| **Hook** | 自动触发的上下文注入脚本 | `.claude/hooks/` |
| **Agent** | 专门角色的 AI 子进程 | `.claude/agents/` |
| **Skill** | 可复用的 AI 能力模块 | `.claude/skills/` |
| **Workflow** | 多阶段开发编排 | `/workflow:*` |
---
## 1.4 架构概览
```
┌─────────────────────────────────────────────────────────────┐
│ Claude_dms3 架构 │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
│ │ CodexLens │ │ CCW │ │ Memory │ │
│ │ (语义索引) │ │ (CLI调用 │ │ (持久化 │ │
│ │ │ │ 框架) │ │ 上下文) │ │
│ └──────┬──────┘ └──────┬──────┘ └──────┬──────┘ │
│ │ │ │ │
│ └────────────────┼────────────────┘ │
│ │ │
│ ┌─────┴─────┐ │
│ │ Spec │ │
│ │ 规范系统 │ │
│ └─────┬─────┘ │
│ │ │
│ ┌────────────────┼────────────────┐ │
│ │ │ │ │
│ ┌────┴────┐ ┌─────┴─────┐ ┌────┴────┐ │
│ │ Hooks │ │ Skills │ │ Agents │ │
│ │ (注入) │ │ (可复用) │ │ (角色) │ │
│ └─────────┘ └───────────┘ └─────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```
---
## 下一步
- [快速开始](ch02-getting-started.md) — 安装和配置
- [核心概念](ch03-core-concepts.md) — 理解基础知识
- [工作流基础](ch04-workflow-basics.md) — 开始你的第一个工作流

295
docs/zh/guide/ch02-getting-started.md Normal file
View File

@@ -0,0 +1,295 @@
# 快速开始
## 一句话定位
**快速开始是 5 分钟上手指南** — 安装配置、第一个命令、第一个工作流，快速体验 Claude_dms3 核心功能。
---
## 2.1 安装
### 2.1.1 前置要求
| 要求 | 版本 | 说明 |
| --- | --- | --- |
| **Node.js** | 18+ | CCW 模块需要 |
| **Python** | 3.10+ | CodexLens 模块需要 |
| **VS Code** | 最新版 | 扩展运行环境 |
| **Git** | 最新版 | 版本控制 |
### 2.1.2 克隆项目
```bash
# 克隆仓库
git clone https://github.com/your-repo/claude-dms3.git
cd claude-dms3
# 安装依赖
npm install
```
### 2.1.3 配置 API Keys
在 `~/.claude/settings.json` 中配置 API Keys：
```json
{
"openai": {
"apiKey": "sk-xxx"
},
"anthropic": {
"apiKey": "sk-ant-xxx"
},
"google": {
"apiKey": "AIza-xxx"
}
}
```
::: tip 提示
API Keys 也可以在项目级别配置 `.claude/settings.json`，项目级配置优先级高于全局配置。
:::
---
## 2.2 初始化项目
### 2.2.1 启动工作流会话
在 VS Code 中打开项目，然后运行：
```
/workflow:session:start
```
这会创建一个新的工作流会话，所有后续操作都会在这个会话上下文中进行。
### 2.2.2 初始化项目规范
```
/workflow:init
```
这会创建 `project-tech.json` 文件，记录项目的技术栈信息。
### 2.2.3 填充项目规范
```
/workflow:init-guidelines
```
交互式填充项目规范，包括编码风格、架构决策等信息。
---
## 2.3 第一个命令
### 2.3.1 代码分析
使用 CCW CLI 工具分析代码：
```bash
ccw cli -p "分析这个文件的代码结构和设计模式" --tool gemini --mode analysis
```
**参数说明**:
- `-p`: Prompt（任务描述）
- `--tool gemini`: 使用 Gemini 模型
- `--mode analysis`: 分析模式（只读，不修改文件）
### 2.3.2 代码生成
使用 CCW CLI 工具生成代码：
```bash
ccw cli -p "创建一个 React 组件，实现用户登录表单" --tool qwen --mode write
```
**参数说明**:
- `--mode write`: 写入模式（可以创建/修改文件）
::: danger 注意
`--mode write` 会修改文件，请确保代码已提交或有备份。
:::
---
## 2.4 第一个工作流
### 2.4.1 启动规划工作流
```
/workflow:plan
```
这会启动 PlanEx 工作流，包含以下步骤：
1. **分析需求** - 理解用户意图
2. **探索代码** - 搜索相关代码和模式
3. **生成计划** - 创建结构化任务列表
4. **执行任务** - 按计划执行开发
### 2.4.2 头脑风暴
```
/brainstorm
```
多视角头脑风暴，获取不同观点：
| 视角 | 角色 | 聚焦 |
| --- | --- | --- |
| Product | 产品经理 | 市场契合度、用户价值 |
| Technical | 技术负责人 | 可行性、技术债 |
| Quality | QA 负责人 | 完整性、可测试性 |
| Risk | 风险分析师 | 风险识别、依赖关系 |
---
## 2.5 使用 Memory
### 2.5.1 查看项目记忆
```bash
ccw memory list
```
显示所有项目记忆，包括 learnings、decisions、conventions、issues。
### 2.5.2 搜索相关记忆
```bash
ccw memory search "认证"
```
基于语义搜索与"认证"相关的记忆。
### 2.5.3 添加记忆
```
/memory-capture
```
交互式捕获当前会话中的重要知识点。
---
## 2.6 代码搜索
### 2.6.1 语义搜索
在 VS Code 中使用 CodexLens 搜索：
```bash
# 通过 CodexLens MCP 端点搜索
ccw search "用户登录逻辑"
```
### 2.6.2 调用链追踪
搜索函数的定义和所有调用位置：
```bash
ccw search --trace "authenticateUser"
```
---
## 2.7 Dashboard 面板
### 2.7.1 打开 Dashboard
在 VS Code 中运行：
```
ccw-dashboard.open
```
或使用命令面板（Ctrl+Shift+P）搜索 "CCW Dashboard"。
### 2.7.2 面板功能
| 功能 | 说明 |
| --- | --- |
| **技术栈** | 显示项目使用的框架和库 |
| **规范文档** | 快速查看项目规范 |
| **Memory** | 浏览和搜索项目记忆 |
| **代码搜索** | 集成 CodexLens 语义搜索 |
---
## 2.8 常见问题
### 2.8.1 API Key 配置
**Q: 在哪里配置 API Keys？**
A: 可以在两个位置配置：
- 全局配置: `~/.claude/settings.json`
- 项目配置: `.claude/settings.json`
项目配置优先级高于全局配置。
### 2.8.2 模型选择
**Q: 如何选择合适的模型？**
A: 根据任务类型选择：
- 代码分析、架构设计 → Gemini
- 通用代码开发 → Qwen
- 代码审查 → Codex (GPT)
- 长文本理解 → Claude
### 2.8.3 工作流选择
**Q: 什么时候使用哪个工作流？**
A: 根据任务目标选择：
- 新功能开发 → `/workflow:plan`
- 问题诊断 → `/debug-with-file`
- 代码审查 → `/review-code`
- 重构规划 → `/refactor-cycle`
- UI 开发 → `/workflow:ui-design`
---
## 2.9 快速参考
### 安装步骤
```bash
# 1. 克隆项目
git clone https://github.com/your-repo/claude-dms3.git
cd claude-dms3
# 2. 安装依赖
npm install
# 3. 配置 API Keys
# 编辑 ~/.claude/settings.json
# 4. 启动工作流会话
/workflow:session:start
# 5. 初始化项目
/workflow:init
```
### 常用命令
| 命令 | 功能 |
| --- | --- |
| `/workflow:session:start` | 启动会话 |
| `/workflow:plan` | 规划工作流 |
| `/brainstorm` | 头脑风暴 |
| `/review-code` | 代码审查 |
| `ccw memory list` | 查看 Memory |
| `ccw cli -p "..."` | CLI 调用 |
---
## 下一步
- [核心概念](ch03-core-concepts.md) — 深入理解 Commands、Skills、Prompts
- [工作流基础](ch04-workflow-basics.md) — 学习使用各种工作流命令
- [高级技巧](ch05-advanced-tips.md) — CLI 工具链、多模型协作、记忆管理优化

264
docs/zh/guide/ch03-core-concepts.md Normal file
View File

@@ -0,0 +1,264 @@
# 核心概念
## 一句话定位
**核心概念是理解 Claude_dms3 的基础** — Commands、Skills、Prompts 三层抽象，Workflow 会话管理，团队协作模式。
---
## 3.1 三层抽象
Claude_dms3 的命令系统分为三层抽象：
### 3.1.1 Commands - 内置命令
**Commands 是 Claude_dms3 的原子操作** — 预定义的可复用命令，完成特定任务。
| 类别 | 命令数量 | 说明 |
| --- | --- | --- |
| **核心编排** | 2 | ccw, ccw-coordinator |
| **CLI 工具** | 2 | cli-init, codex-review |
| **Issue 工作流** | 8 | discover, plan, execute, queue 等 |
| **Memory** | 2 | prepare, style-skill-memory |
| **Workflow 会话** | 6 | start, resume, list, complete 等 |
| **Workflow 分析** | 10+ | analyze, brainstorm, debug, refactor 等 |
| **Workflow UI 设计** | 9 | generate, import-from-code, style-extract 等 |
::: tip 提示
Commands 定义在 `.claude/commands/` 目录，每个命令是一个 Markdown 文件。
:::
### 3.1.2 Skills - 复合技能
**Skills 是 Commands 的组合封装** — 针对特定场景的可复用技能，包含多个步骤和最佳实践。
| Skill | 功能 | 触发方式 |
| --- | --- | --- |
| **brainstorm** | 多视角头脑风暴 | `/brainstorm` |
| **ccw-help** | CCW 命令帮助 | `/ccw-help` |
| **command-generator** | 生成 Claude 命令 | `/command-generator` |
| **issue-manage** | Issue 管理 | `/issue-manage` |
| **memory-capture** | Memory 压缩和捕获 | `/memory-capture` |
| **memory-manage** | Memory 更新 | `/memory-manage` |
| **review-code** | 多维度代码审查 | `/review-code` |
| **review-cycle** | 代码审查和修复循环 | `/review-cycle` |
| **skill-generator** | 生成 Claude 技能 | `/skill-generator` |
| **skill-tuning** | Skill 诊断和调优 | `/skill-tuning` |
::: tip 提示
Skills 定义在 `.claude/skills/` 目录，包含 SKILL.md 规范文件和参考文档。
:::
### 3.1.3 Prompts - Codex 提示
**Prompts 是 Codex 模型的指令模板** — 针对 Codex (GPT) 模型优化的提示模板。
| Prompt | 功能 |
| --- | --- |
| **prep-cycle** | Prep 周期提示 |
| **prep-plan** | Prep 规划提示 |
::: tip 提示
Codex Prompts 定义在 `.codex/prompts/` 目录，专为 Codex 模型优化。
:::
---
## 3.2 三层关系
```
┌─────────────────────────────────────────────────────┐
│ 用户请求 │
└────────────────────┬────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────┐
│ ccw (编排器) │
│ 意图分析 → 工作流选择 → 命令链执行 │
└────────────────────┬────────────────────────────────┘
│
┌───────────┼───────────┐
▼ ▼ ▼
┌────────┐ ┌────────┐ ┌────────┐
│ Command│ │ Skill │ │ Prompt │
│ (原子) │ │ (复合) │ │(模板) │
└────────┘ └────────┘ └────────┘
│ │ │
└───────────┼───────────┘
▼
┌────────────────┐
│ AI 模型调用 │
└────────────────┘
```
### 3.2.1 调用路径
1. **用户发起请求** → 在 VS Code 中输入命令或描述需求
2. **ccw 编排** → 意图分析，选择合适的工作流
3. **执行 Command** → 执行原子命令操作
4. **调用 Skill** → 如需复杂逻辑，调用组合技能
5. **使用 Prompt** → 如需特定模型，使用优化提示
6. **AI 模型执行** → 调用配置的 AI 模型
7. **返回结果** → 格式化输出给用户
---
## 3.3 Workflow 会话管理
### 3.3.1 会话生命周期
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ Start │────▶│ Resume │────▶│ Execute │────▶│Complete │
│ 启动 │ │ 恢复 │ │ 执行 │ │ 完成 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │
▼ ▼
┌─────────┐ ┌─────────┐
│ List │ │ Solidify│
│ 列出 │ │ 固化 │
└─────────┘ └─────────┘
```
### 3.3.2 会话命令
| 命令 | 功能 | 示例 |
| --- | --- | --- |
| **start** | 启动新会话 | `/workflow:session:start` |
| **resume** | 恢复已有会话 | `/workflow:session:resume <session-id>` |
| **list** | 列出所有会话 | `/workflow:session:list` |
| **sync** | 同步会话状态 | `/workflow:session:sync` |
| **complete** | 完成当前会话 | `/workflow:session:complete` |
| **solidify** | 固化会话成果 | `/workflow:session:solidify` |
### 3.3.3 会话目录结构
```
.workflow/
├── .team/
│ └── TC-<project>-<date>/ # 会话目录
│ ├── spec/ # 会话规范
│ │ ├── discovery-context.json
│ │ └── requirements.md
│ ├── artifacts/ # 会话产物
│ ├── wisdom/ # 会话智慧
│ │ ├── learnings.md
│ │ ├── decisions.md
│ │ ├── conventions.md
│ │ └── issues.md
│ └── .team-msg/ # 消息总线
```
---
## 3.4 团队协作模式
### 3.4.1 角色系统
Claude_dms3 支持 8 种团队工作流，每种工作流定义了不同的角色：
| 工作流 | 角色 | 说明 |
| --- | --- | --- |
| **PlanEx** | planner, executor | 规划执行分离 |
| **IterDev** | developer, reviewer | 迭代开发 |
| **Lifecycle** | analyzer, developer, tester, reviewer | 生命周期覆盖 |
| **Issue** | discoverer, planner, executor | Issue 驱动 |
| **Testing** | tester, developer | 测试驱动 |
| **QA** | qa, developer | 质量保证 |
| **Brainstorm** | facilitator, perspectives | 多视角分析 |
| **UIDesign** | designer, developer | UI 设计生成 |
### 3.4.2 消息总线
团队成员通过消息总线通信：
```
┌────────────┐ ┌────────────┐
│ Planner │ │ Executor │
└─────┬──────┘ └──────┬─────┘
│ │
│ [plan_ready] │
├────────────────────────────────▶
│ │
│ [task_complete]
│◀────────────────────────────────┤
│ │
│ [plan_approved] │
├────────────────────────────────▶
│ │
```
### 3.4.3 工作流选择指南
| 任务目标 | 推荐工作流 | 命令 |
| --- | --- | --- |
| 新功能开发 | PlanEx | `/workflow:plan` |
| Bug 修复 | Lifecycle | `/debug-with-file` |
| 代码重构 | IterDev | `/refactor-cycle` |
| 技术决策 | Brainstorm | `/brainstorm-with-file` |
| UI 开发 | UIDesign | `/workflow:ui-design` |
| 集成测试 | Testing | `/integration-test-cycle` |
| 代码审查 | QA | `/review-cycle` |
| Issue 管理 | Issue | `/issue` 系列 |
---
## 3.5 核心概念速览
| 概念 | 说明 | 位置/命令 |
| --- | --- | --- |
| **Command** | 原子操作命令 | `.claude/commands/` |
| **Skill** | 复合技能封装 | `.claude/skills/` |
| **Prompt** | Codex 提示模板 | `.codex/prompts/` |
| **Workflow** | 团队协作流程 | `/workflow:*` |
| **Session** | 会话上下文管理 | `/workflow:session:*` |
| **Memory** | 跨会话知识持久化 | `ccw memory` |
| **Spec** | 项目规范约束 | `.workflow/specs/` |
| **CodexLens** | 语义代码索引 | `.codex-lens/` |
| **CCW** | CLI 调用框架 | `ccw` 目录 |
---
## 3.6 数据流
```
用户请求
│
▼
┌──────────────┐
│ CCW 编排器 │ ──▶ 意图分析
└──────────────┘
│
├─▶ Workflow 选择
│ │
│ ├─▶ PlanEx
│ ├─▶ IterDev
│ ├─▶ Lifecycle
│ └─▶ ...
│
├─▶ Command 执行
│ │
│ ├─▶ 内置命令
│ └─▶ Skill 调用
│
├─▶ AI 模型调用
│ │
│ ├─▶ Gemini
│ ├─▶ Qwen
│ ├─▶ Codex
│ └─▶ Claude
│
└─▶ 结果返回
│
├─▶ 文件修改
├─▶ Memory 更新
└─▶ Dashboard 更新
```
---
## 下一步
- [工作流基础](ch04-workflow-basics.md) — 学习使用各种工作流命令
- [高级技巧](ch05-advanced-tips.md) — CLI 工具链、多模型协作
- [最佳实践](ch06-best-practices.md) — 团队协作规范、代码审查流程

320
docs/zh/guide/ch04-workflow-basics.md Normal file
View File

@@ -0,0 +1,320 @@
# 工作流基础
## 一句话定位
**工作流是团队协作的核心** — 8 种工作流覆盖开发全流程，从规划到执行，从分析到测试。
---
## 4.1 工作流概览
| 工作流 | 核心命令 | 适用场景 | 角色 |
| --- | --- | --- | --- |
| **PlanEx** | `/workflow:plan` | 新功能开发、需求实现 | planner, executor |
| **IterDev** | `/refactor-cycle` | 代码重构、技术债处理 | developer, reviewer |
| **Lifecycle** | `/unified-execute-with-file` | 完整开发周期 | analyzer, developer, tester, reviewer |
| **Issue** | `/issue:*` | Issue 驱动开发 | discoverer, planner, executor |
| **Testing** | `/integration-test-cycle` | 集成测试、测试生成 | tester, developer |
| **QA** | `/review-cycle` | 代码审查和质量保证 | qa, developer |
| **Brainstorm** | `/brainstorm-with-file` | 多视角分析、技术决策 | facilitator, perspectives |
| **UIDesign** | `/workflow:ui-design` | UI 设计和代码生成 | designer, developer |
---
## 4.2 PlanEx - 规划执行工作流
### 4.2.1 一句话定位
**PlanEx 是规划与执行分离的工作流** — 先规划再执行，确保任务清晰后再动手。
### 4.2.2 启动方式
```
/workflow:plan
```
或直接描述需求：
```
实现用户登录功能，支持邮箱和手机号登录
```
### 4.2.3 工作流程
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ Planner │────▶│ Executor │────▶│ Reviewer │
│ 规划阶段 │ │ 执行阶段 │ │ 审查阶段 │
└─────────────┘ └─────────────┘ └─────────────┘
│ │ │
▼ ▼ ▼
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ 需求分析 │ │ 任务执行 │ │ 代码审查 │
│ 任务分解 │ │ 代码生成 │ │ 质量检查 │
│ 计划生成 │ │ 测试编写 │ │ 反馈修复 │
└─────────────┘ └─────────────┘ └─────────────┘
```
### 4.2.4 输出产物
| 产物 | 位置 | 说明 |
| --- | --- | --- |
| **需求分析** | `artifacts/requirements.md` | 需求详细分析 |
| **任务计划** | `artifacts/plan.md` | 结构化任务列表 |
| **执行产物** | `artifacts/implementation/` | 代码和测试 |
| **智慧积累** | `wisdom/learnings.md` | 过程中学到的经验 |
---
## 4.3 IterDev - 迭代开发工作流
### 4.3.1 一句话定位
**IterDev 是迭代重构工作流** — 发现技术债、规划重构、迭代改进。
### 4.3.2 启动方式
```
/refactor-cycle
```
### 4.3.3 工作流程
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ Discover │────▶│ Plan │────▶│ Refactor │
│ 发现阶段 │ │ 规划阶段 │ │ 重构阶段 │
└─────────────┘ └─────────────┘ └─────────────┘
│ │ │
▼ ▼ ▼
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ 代码分析 │ │ 重构策略 │ │ 代码修改 │
│ 问题识别 │ │ 优先级排序 │ │ 测试验证 │
│ 技术债记录 │ │ 任务分解 │ │ 文档更新 │
└─────────────┘ └─────────────┘ └─────────────┘
```
### 4.3.4 使用场景
| 场景 | 示例 |
| --- | --- |
| **代码异味** | 函数过长、重复代码 |
| **架构改进** | 解耦合、模块化 |
| **性能优化** | 算法优化、缓存策略 |
| **安全加固** | 修复安全漏洞 |
| **规范统一** | 代码风格统一 |
---
## 4.4 Lifecycle - 生命周期工作流
### 4.4.1 一句话定位
**Lifecycle 是全生命周期覆盖工作流** — 从分析到测试到审查，完整闭环。
### 4.4.2 启动方式
```
/unified-execute-with-file <file>
```
### 4.4.3 角色职责
| 角色 | 职责 | 输出 |
| --- | --- | --- |
| **Analyzer** | 分析需求、探索代码 | 分析报告 |
| **Developer** | 实现功能、编写测试 | 代码 + 测试 |
| **Tester** | 运行测试、验证功能 | 测试报告 |
| **Reviewer** | 代码审查、质量检查 | 审查报告 |
### 4.4.4 工作流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│Analyzer │──▶│Developer│──▶│ Tester │──▶│Reviewer │
│ 分析 │ │ 开发 │ │ 测试 │ │ 审查 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ │ │
▼ ▼ ▼ ▼
需求分析 代码实现 测试验证 质量把关
代码探索 单元测试 回归测试 最终确认
```
---
## 4.5 Issue - Issue 管理工作流
### 4.5.1 一句话定位
**Issue 是 Issue 驱动开发工作流** — 从 Issue 发现到规划到执行，完整追踪。
### 4.5.2 Issue 命令
| 命令 | 功能 | 示例 |
| --- | --- | --- |
| **discover** | 发现 Issue | `/issue discover https://github.com/xxx/issue/1` |
| **discover-by-prompt** | 从 Prompt 创建 | `/issue discover-by-prompt "登录失败"` |
| **from-brainstorm** | 从头脑风暴创建 | `/issue from-brainstorm` |
| **plan** | 批量规划 Issue | `/issue plan` |
| **queue** | 形成执行队列 | `/issue queue` |
| **execute** | 执行 Issue 队列 | `/issue execute` |
### 4.5.3 工作流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│Discover │──▶│ Plan │──▶│ Queue │──▶│ Execute │
│ 发现 │ │ 规划 │ │ 排队 │ │ 执行 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ │ │
▼ ▼ ▼ ▼
识别问题 分析需求 优先级排序 实现方案
定义范围 制定计划 依赖关系 验证结果
```
---
## 4.6 Testing - 测试工作流
### 4.6.1 一句话定位
**Testing 是自迭代测试工作流** — 自动生成测试、迭代改进测试覆盖率。
### 4.6.2 启动方式
```
/integration-test-cycle
```
### 4.6.3 工作流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐
│Generate │──▶│ Execute │──▶│ Verify │
│ 生成 │ │ 执行 │ │ 验证 │
└─────────┘ └─────────┘ └─────────┘
│ │ │
▼ ▼ ▼
测试用例 运行测试 覆盖率分析
Mock 数据 失败分析 缺口补充
```
---
## 4.7 QA - 质量保证工作流
### 4.7.1 一句话定位
**QA 是代码审查工作流** — 6 维度代码审查，自动发现问题。
### 4.7.2 启动方式
```
/review-cycle
```
### 4.7.3 审查维度
| 维度 | 检查项 |
| --- | --- |
| **正确性** | 逻辑正确、边界处理 |
| **性能** | 算法效率、资源使用 |
| **安全** | 注入漏洞、权限检查 |
| **可维护性** | 代码清晰、模块化 |
| **测试覆盖** | 单元测试、边界测试 |
| **规范符合** | 编码规范、项目约定 |
---
## 4.8 Brainstorm - 头脑风暴工作流
### 4.8.1 一句话定位
**Brainstorm 是多视角分析工作流** — 从多个视角分析问题，获得全面洞察。
### 4.8.2 启动方式
```
/brainstorm-with-file <file>
```
### 4.8.3 分析视角
| 视角 | 角色 | 聚焦 |
| --- | --- | --- |
| **Product** | 产品经理 | 市场契合、用户价值 |
| **Technical** | 技术负责人 | 可行性、技术债 |
| **Quality** | QA 负责人 | 完整性、可测试性 |
| **Risk** | 风险分析师 | 风险识别、依赖关系 |
### 4.8.4 输出格式
```markdown
## 一致结论
- [共识点 1]
- [共识点 2]
## 分歧点
- [分歧 1]
- 视角 A: ...
- 视角 B: ...
- 建议: ...
## 行动项
- [ ] [行动项 1]
- [ ] [行动项 2]
```
---
## 4.9 UIDesign - UI 设计工作流
### 4.9.1 一句话定位
**UIDesign 是 UI 设计生成工作流** — 从设计稿到代码，自动提取样式和布局。
### 4.9.2 UI 设计命令
| 命令 | 功能 |
| --- | --- |
| **generate** | 生成 UI 组件 |
| **import-from-code** | 从代码导入样式 |
| **style-extract** | 提取样式规范 |
| **layout-extract** | 提取布局结构 |
| **imitate-auto** | 模仿参考页面 |
| **codify-style** | 样式代码化 |
| **design-sync** | 同步设计变更 |
---
## 4.10 快速参考
### 工作流选择指南
| 需求 | 推荐工作流 | 命令 |
| --- | --- | --- |
| 新功能开发 | PlanEx | `/workflow:plan` |
| 代码重构 | IterDev | `/refactor-cycle` |
| 完整开发 | Lifecycle | `/unified-execute-with-file` |
| Issue 管理 | Issue | `/issue:*` |
| 测试生成 | Testing | `/integration-test-cycle` |
| 代码审查 | QA | `/review-cycle` |
| 多视角分析 | Brainstorm | `/brainstorm-with-file` |
| UI 开发 | UIDesign | `/workflow:ui-design` |
### 会话管理命令
| 命令 | 功能 |
| --- | --- |
| `/workflow:session:start` | 启动新会话 |
| `/workflow:session:resume` | 恢复会话 |
| `/workflow:session:list` | 列出会话 |
| `/workflow:session:complete` | 完成会话 |
| `/workflow:session:solidify` | 固化成果 |
---
## 下一步
- [高级技巧](ch05-advanced-tips.md) — CLI 工具链、多模型协作
- [最佳实践](ch06-best-practices.md) — 团队协作规范、代码审查流程

331
docs/zh/guide/ch05-advanced-tips.md Normal file
View File

@@ -0,0 +1,331 @@
# 高级技巧
## 一句话定位
**高级技巧是提升效率的关键** — CLI 工具链深度使用、多模型协作优化、记忆管理最佳实践。
---
## 5.1 CLI 工具链使用
### 5.1.1 CLI 配置
CLI 工具配置文件：`~/.claude/cli-tools.json`
```json
{
"version": "3.3.0",
"tools": {
"gemini": {
"enabled": true,
"primaryModel": "gemini-2.5-flash",
"secondaryModel": "gemini-2.5-flash",
"tags": ["分析", "Debug"],
"type": "builtin"
},
"qwen": {
"enabled": true,
"primaryModel": "coder-model",
"secondaryModel": "coder-model",
"tags": [],
"type": "builtin"
},
"codex": {
"enabled": true,
"primaryModel": "gpt-5.2",
"secondaryModel": "gpt-5.2",
"tags": [],
"type": "builtin"
}
}
}
```
### 5.1.2 标签路由
根据任务类型自动选择模型：
| 标签 | 适用模型 | 任务类型 |
| --- | --- | --- |
| **分析** | Gemini | 代码分析、架构设计 |
| **Debug** | Gemini | 根因分析、问题诊断 |
| **实现** | Qwen | 功能开发、代码生成 |
| **审查** | Codex | 代码审查、Git 操作 |
### 5.1.3 CLI 命令模板
#### 分析任务
```bash
ccw cli -p "PURPOSE: 识别安全漏洞
TASK: • 扫描 SQL 注入 • 检查 XSS • 验证 CSRF
MODE: analysis
CONTEXT: @src/auth/**/*
EXPECTED: 安全报告，含严重性分级和修复建议
CONSTRAINTS: 聚焦认证模块" --tool gemini --mode analysis --rule analysis-assess-security-risks
```
#### 实现任务
```bash
ccw cli -p "PURPOSE: 实现速率限制
TASK: • 创建中间件 • 配置路由 • Redis 后端
MODE: write
CONTEXT: @src/middleware/**/* @src/config/**/*
EXPECTED: 生产代码 + 单元测试 + 集成测试
CONSTRAINTS: 遵循现有中间件模式" --tool qwen --mode write --rule development-implement-feature
```
### 5.1.4 规则模板
| 规则 | 用途 |
| --- | --- |
| **analysis-diagnose-bug-root-cause** | Bug 根因分析 |
| **analysis-analyze-code-patterns** | 代码模式分析 |
| **analysis-review-architecture** | 架构审查 |
| **analysis-assess-security-risks** | 安全评估 |
| **development-implement-feature** | 功能实现 |
| **development-refactor-codebase** | 代码重构 |
| **development-generate-tests** | 测试生成 |
---
## 5.2 多模型协作
### 5.2.1 模型选择指南
| 任务 | 推荐模型 | 理由 |
| --- | --- | --- |
| **代码分析** | Gemini | 擅长深度代码理解和模式识别 |
| **Bug 诊断** | Gemini | 强大的根因分析能力 |
| **功能开发** | Qwen | 代码生成效率高 |
| **代码审查** | Codex (GPT) | Git 集成好，审查格式标准 |
| **长文本** | Claude | 上下文窗口大 |
### 5.2.2 协作模式
#### 串行协作
```bash
# 步骤 1: Gemini 分析
ccw cli -p "分析代码架构" --tool gemini --mode analysis
# 步骤 2: Qwen 实现
ccw cli -p "基于分析结果实现功能" --tool qwen --mode write
# 步骤 3: Codex 审查
ccw cli -p "审查实现代码" --tool codex --mode review
```
#### 并行协作
使用 `--tool gemini` 和 `--tool qwen` 同时分析同一问题：
```bash
# 终端 1
ccw cli -p "从性能角度分析" --tool gemini --mode analysis &
# 终端 2
ccw cli -p "从安全角度分析" --tool codex --mode analysis &
```
### 5.2.3 会话恢复
跨模型会话恢复：
```bash
# 第一次调用
ccw cli -p "分析认证模块" --tool gemini --mode analysis
# 恢复会话继续
ccw cli -p "基于上次分析，设计改进方案" --tool qwen --mode write --resume
```
---
## 5.3 Memory 管理
### 5.3.1 Memory 分类
| 分类 | 用途 | 示例内容 |
| --- | --- | --- |
| **learnings** | 学习心得 | 新技术使用经验 |
| **decisions** | 架构决策 | 技术选型理由 |
| **conventions** | 编码规范 | 命名约定、模式 |
| **issues** | 已知问题 | Bug、限制、TODO |
### 5.3.2 Memory 命令
| 命令 | 功能 | 示例 |
| --- | --- | --- |
| **list** | 列出所有记忆 | `ccw memory list` |
| **search** | 搜索记忆 | `ccw memory search "认证"` |
| **export** | 导出记忆 | `ccw memory export <id>` |
| **import** | 导入记忆 | `ccw memory import "..."` |
| **embed** | 生成嵌入 | `ccw memory embed <id>` |
### 5.3.3 Memory 最佳实践
::: tip 提示
- **定期整理**: 每周整理一次 Memory，删除过时内容
- **结构化**: 使用标准格式，便于搜索和复用
- **上下文**: 记录决策背景，不只是结论
- **链接**: 相关内容互相引用
:::
### 5.3.4 Memory 模板
```markdown
## 标题
### 背景
- **问题**: ...
- **影响**: ...
### 决策
- **方案**: ...
- **理由**: ...
### 结果
- **效果**: ...
- **经验**: ...
### 相关
- [相关记忆 1](memory-id-1)
- [相关文档](link)
```
---
## 5.4 CodexLens 高级用法
### 5.4.1 混合搜索
结合向量搜索和关键词搜索：
```bash
# 纯向量搜索
ccw search --mode vector "用户认证"
# 混合搜索（默认）
ccw search --mode hybrid "用户认证"
# 纯关键词搜索
ccw search --mode keyword "authenticate"
```
### 5.4.2 调用链追踪
追踪函数的完整调用链：
```bash
# 向上追踪（谁调用了我）
ccw search --trace-up "authenticateUser"
# 向下追踪（我调用了谁）
ccw search --trace-down "authenticateUser"
# 完整调用链
ccw search --trace-full "authenticateUser"
```
### 5.4.3 语义搜索技巧
| 技巧 | 示例 | 效果 |
| --- | --- | --- |
| **功能描述** | "处理用户登录" | 找到登录相关代码 |
| **问题描述** | "内存泄漏的地方" | 找到潜在问题 |
| **模式描述** | "单例模式的实现" | 找到设计模式 |
| **技术描述** | "使用 React Hooks" | 找到相关用法 |
---
## 5.5 Hook 自动注入
### 5.5.1 Hook 类型
| Hook 类型 | 触发时机 | 用途 |
| --- | --- | --- |
| **pre-command** | 命令执行前 | 注入规范、加载上下文 |
| **post-command** | 命令执行后 | 保存 Memory、更新状态 |
| **pre-commit** | Git 提交前 | 代码审查、规范检查 |
| **file-change** | 文件变更时 | 自动格式化、更新索引 |
### 5.5.2 Hook 配置
在 `.claude/hooks.json` 中配置：
```json
{
"pre-command": [
{
"name": "inject-specs",
"description": "注入项目规范",
"command": "cat .workflow/specs/project-constraints.md"
},
{
"name": "load-memory",
"description": "加载相关 Memory",
"command": "ccw memory search \"{query}\""
}
],
"post-command": [
{
"name": "save-memory",
"description": "保存重要决策",
"command": "ccw memory import \"{content}\""
}
]
}
```
---
## 5.6 性能优化
### 5.6.1 索引优化
| 优化项 | 说明 |
| --- | --- |
| **增量索引** | 只索引变更文件 |
| **并行索引** | 多进程并行处理 |
| **缓存策略** | 向量嵌入缓存 |
### 5.6.2 搜索优化
| 优化项 | 说明 |
| --- | --- |
| **结果缓存** | 相同查询返回缓存 |
| **分页加载** | 大结果集分页返回 |
| **智能去重** | 相似结果自动去重 |
---
## 5.7 快速参考
### CLI 命令速查
| 命令 | 功能 |
| --- | --- |
| `ccw cli -p "..." --tool gemini --mode analysis` | 分析任务 |
| `ccw cli -p "..." --tool qwen --mode write` | 实现任务 |
| `ccw cli -p "..." --tool codex --mode review` | 审查任务 |
| `ccw memory list` | 列出记忆 |
| `ccw memory search "..."` | 搜索记忆 |
| `ccw search "..."` | 语义搜索 |
| `ccw search --trace "..."` | 调用链追踪 |
### 规则模板速查
| 规则 | 用途 |
| --- | --- |
| `analysis-diagnose-bug-root-cause` | Bug 分析 |
| `analysis-assess-security-risks` | 安全评估 |
| `development-implement-feature` | 功能实现 |
| `development-refactor-codebase` | 代码重构 |
| `development-generate-tests` | 测试生成 |
---
## 下一步
- [最佳实践](ch06-best-practices.md) — 团队协作规范、代码审查流程、文档维护策略

330
docs/zh/guide/ch06-best-practices.md Normal file
View File

@@ -0,0 +1,330 @@
# 最佳实践
## 一句话定位
**最佳实践是团队高效协作的保障** — 规范制定、代码审查、文档维护、团队协作的实践经验总结。
---
## 6.1 团队协作规范
### 6.1.1 角色职责定义
| 角色 | 职责 | 技能要求 |
| --- | --- | --- |
| **Planner** | 需求分析、任务分解 | 架构思维、沟通能力 |
| **Developer** | 代码实现、单元测试 | 编码能力、测试意识 |
| **Reviewer** | 代码审查、质量把关 | 代码敏感度、规范理解 |
| **QA** | 质量保证、测试验证 | 测试设计、风险识别 |
| **Facilitator** | 协调沟通、进度跟踪 | 项目管理、冲突解决 |
### 6.1.2 工作流选择
| 场景 | 推荐工作流 | 理由 |
| --- | --- | --- |
| **新功能开发** | PlanEx | 规划与执行分离，降低风险 |
| **Bug 修复** | Lifecycle | 完整闭环，确保修复质量 |
| **代码重构** | IterDev | 迭代改进，持续优化 |
| **技术决策** | Brainstorm | 多视角分析，全面考虑 |
| **Issue 管理** | Issue | 可追溯，易管理 |
| **UI 开发** | UIDesign | 设计到代码无缝衔接 |
### 6.1.3 沟通协议
#### 消息格式
```
[<角色>] <操作> <对象>: <结果>
示例:
[Planner] 任务分解完成: 生成 5 个子任务
[Developer] 代码实现完成: user-auth.ts, 324 行
[Reviewer] 代码审查完成: 发现 2 个问题，建议 1 处优化
```
#### 状态报告
| 状态 | 含义 | 后续动作 |
| --- | --- | --- |
| **pending** | 待处理 | 等待依赖完成 |
| **in_progress** | 进行中 | 继续执行 |
| **completed** | 已完成 | 可以被依赖 |
| **blocked** | 被阻塞 | 需要人工介入 |
---
## 6.2 代码审查流程
### 6.2.1 审查维度
| 维度 | 检查项 | 严重性 |
| --- | --- | --- |
| **正确性** | 逻辑正确、边界处理 | HIGH |
| **性能** | 算法效率、资源使用 | MEDIUM |
| **安全** | 注入漏洞、权限检查 | HIGH |
| **可维护性** | 代码清晰、模块化 | MEDIUM |
| **测试覆盖** | 单元测试、边界测试 | MEDIUM |
| **规范符合** | 编码规范、项目约定 | LOW |
### 6.2.2 审查流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ 提交 │──▶│ 审查 │──▶│ 反馈 │──▶│ 修复 │
│ 代码 │ │ 代码 │ │ 意见 │ │ 问题 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ │ │
▼ ▼ ▼ ▼
Push PR 自动审查 人工审查 修复验证
CI 检查 6 维度检查 代码走查 再次审查
```
### 6.2.3 审查清单
#### 代码正确性
- [ ] 逻辑正确，无 bug
- [ ] 边界条件处理
- [ ] 错误处理完整
- [ ] 资源释放正确
#### 性能
- [ ] 算法复杂度合理
- [ ] 无内存泄漏
- [ ] 无冗余计算
- [ ] 缓存策略合理
#### 安全
- [ ] 无 SQL 注入
- [ ] 无 XSS 漏洞
- [ ] 权限检查完整
- [ ] 敏感数据保护
#### 可维护性
- [ ] 命名清晰
- [ ] 模块化良好
- [ ] 注释充分
- [ ] 易于测试
#### 测试覆盖
- [ ] 单元测试完整
- [ ] 边界测试覆盖
- [ ] 异常情况测试
- [ ] 集成测试验证
#### 规范符合
- [ ] 编码风格统一
- [ ] 命名规范遵守
- [ ] 项目约定遵循
- [ ] 文档完整
### 6.2.4 反馈格式
```markdown
## 审查结果
### 问题
1. **[HIGH]** SQL 注入风险
- 位置: `src/auth/login.ts:45`
- 建议: 使用参数化查询
2. **[MEDIUM]** 性能问题
- 位置: `src/utils/cache.ts:78`
- 建议: 使用 LRU 缓存
### 建议
1. 命名优化: `data` → `userData`
2. 模块拆分: 建议将 Auth 逻辑独立
### 通过条件
- [ ] 修复 HIGH 问题
- [ ] 考虑 MEDIUM 建议
```
---
## 6.3 文档维护策略
### 6.3.1 文档分类
| 类型 | 位置 | 更新频率 | 负责人 |
| --- | --- | --- | --- |
| **规范文档** | `.workflow/specs/` | 按需 | 架构师 |
| **参考文档** | `docs/ref/` | 每次变更 | 开发者 |
| **指南文档** | `docs/guide/` | 每月 | 技术写手 |
| **API 文档** | `docs/api/` | 自动生成 | 工具 |
| **FAQ** | `docs/faq.md` | 每周 | 支持团队 |
### 6.3.2 文档更新触发
| 事件 | 更新内容 |
| --- | --- |
| **新增功能** | 添加功能文档和 API 参考 |
| **规范变更** | 更新规范文档和迁移指南 |
| **Bug 修复** | 更新 FAQ 和已知问题 |
| **架构变更** | 更新架构文档和决策记录 |
| **代码审查** | 补充缺失的注释和文档 |
### 6.3.3 文档质量标准
| 标准 | 要求 |
| --- | --- |
| **准确性** | 与实际代码一致 |
| **完整性** | 覆盖所有公开 API |
| **清晰性** | 易于理解，示例充分 |
| **时效性** | 及时更新，不滞后 |
| **可导航** | 结构清晰，易于查找 |
---
## 6.4 Memory 管理最佳实践
### 6.4.1 Memory 记录时机
| 时机 | 记录内容 |
| --- | --- |
| **架构决策** | 技术选型、设计决策 |
| **问题解决** | Bug 根因、解决方案 |
| **经验总结** | 最佳实践、避坑指南 |
| **规范约定** | 编码规范、命名约定 |
| **已知问题** | Bug、限制、TODO |
### 6.4.2 Memory 格式规范
```markdown
## [类型] 标题
### 背景
- **问题**: ...
- **影响**: ...
- **上下文**: ...
### 分析/决策
- **方案**: ...
- **理由**: ...
- **替代方案**: ...
### 结果
- **效果**: ...
- **数据**: ...
### 相关
- [相关记忆](memory-id)
- [相关代码](file-link)
- [相关文档](doc-link)
```
### 6.4.3 Memory 维护
| 维护项 | 频率 | 内容 |
| --- | --- | --- |
| **去重** | 每周 | 合并重复记忆 |
| **更新** | 按需 | 更新过时内容 |
| **归档** | 每月 | 归档历史记忆 |
| **清理** | 每季度 | 删除无用记忆 |
---
## 6.5 Hook 使用规范
### 6.5.1 Hook 类型
| Hook 类型 | 用途 | 示例 |
| --- | --- | --- |
| **pre-command** | 注入规范、加载上下文 | 自动加载 CLAUDE.md |
| **post-command** | 保存 Memory、更新索引 | 自动保存决策 |
| **pre-commit** | 代码审查、规范检查 | 自动运行 Lint |
| **file-change** | 自动格式化、更新索引 | 自动格式化代码 |
### 6.5.2 Hook 配置原则
| 原则 | 说明 |
| --- | --- |
| **最小化** | 只配置必要的 Hook |
| **幂等性** | Hook 执行结果可重复 |
| **可恢复** | Hook 失败不影响主流程 |
| **可观测** | Hook 执行有日志记录 |
---
## 6.6 团队协作技巧
### 6.6.1 冲突解决
| 冲突类型 | 解决策略 |
| --- | --- |
| **规范冲突** | 团队讨论，统一规范 |
| **技术分歧** | 头脑风暴，数据驱动 |
| **进度冲突** | 优先级排序，资源调整 |
| **质量冲突** | 制定标准，自动化检查 |
### 6.6.2 知识共享
| 方式 | 频率 | 内容 |
| --- | --- | --- |
| **技术分享** | 每周 | 新技术、最佳实践 |
| **代码走查** | 每次 PR | 代码逻辑、设计思路 |
| **文档同步** | 每月 | 文档更新、规范变更 |
| **问题复盘** | 每次事故 | 根因分析、改进措施 |
### 6.6.3 效率提升
| 技巧 | 效果 |
| --- | --- |
| **模板化** | 复用成功模式 |
| **自动化** | 减少重复工作 |
| **工具化** | 提升开发效率 |
| **标准化** | 降低沟通成本 |
---
## 6.7 快速参考
### 工作流选择指南
| 场景 | 工作流 | 命令 |
| --- | --- | --- |
| 新功能 | PlanEx | `/workflow:plan` |
| Bug 修复 | Lifecycle | `/unified-execute-with-file` |
| 重构 | IterDev | `/refactor-cycle` |
| 决策 | Brainstorm | `/brainstorm-with-file` |
| UI 开发 | UIDesign | `/workflow:ui-design` |
### 代码审查清单
- [ ] 正确性检查
- [ ] 性能检查
- [ ] 安全检查
- [ ] 可维护性检查
- [ ] 测试覆盖检查
- [ ] 规范符合检查
### Memory 维护
| 操作 | 命令 |
| --- | --- |
| 列出记忆 | `ccw memory list` |
| 搜索记忆 | `ccw memory search "..."` |
| 导入记忆 | `ccw memory import "..."` |
| 导出记忆 | `ccw memory export <id>` |
---
## 总结
Claude_dms3 的最佳实践可以总结为：
1. **规范先行** - 制定清晰的团队规范
2. **流程保障** - 使用合适的工作流
3. **质量把关** - 严格的代码审查
4. **知识沉淀** - 持续维护 Memory 和文档
5. **持续改进** - 定期复盘和优化
---
## 相关链接
- [Claude_dms3 是什么](ch01-what-is-claude-dms3.md)
- [快速开始](ch02-getting-started.md)
- [核心概念](ch03-core-concepts.md)
- [工作流基础](ch04-workflow-basics.md)
- [高级技巧](ch05-advanced-tips.md)

50
docs/zh/guide/getting-started.md Normal file
View File

@@ -0,0 +1,50 @@
# 快速入门
欢迎使用 CCW (Claude Code Workspace) - 一个先进的 AI 驱动开发环境，帮助您更快地编写更好的代码。
## 什么是 CCW？
CCW 是一个综合开发环境，结合了：
- **AI 驱动 CLI 工具**：使用多个 AI 后端进行分析、审查和实现代码
- **专业化代理**：前端、后端、测试和文档代理
- **工作流编排**：从规范到实现的 4 级工作流系统
- **可扩展技能**：27+ 内置技能，支持自定义技能
- **MCP 集成**：模型上下文协议，增强工具集成
## 快速开始
### 安装
```bash
# 全局安装 CCW
npm install -g @ccw/cli
# 或使用 npx
npx ccw --help
```
### 第一个工作流
在 5 分钟内创建一个简单工作流：
```bash
# 初始化新项目
ccw init my-project
# 分析现有代码
ccw cli -p "分析代码库结构" --mode analysis
# 实现新功能
ccw cli -p "添加用户认证" --mode write
```
## 下一步
- [安装指南](./installation.md) - 详细安装说明
- [第一个工作流](./first-workflow.md) - 30 分钟快速入门教程
- [配置指南](./configuration.md) - 自定义 CCW 设置
::: tip 需要帮助？
查看我们的 [GitHub Discussions](https://github.com/your-repo/ccw/discussions) 或加入 [Discord 社区](https://discord.gg/ccw)。
:::

118
docs/zh/guide/installation.md Normal file
View File

@@ -0,0 +1,118 @@
# 安装
了解如何在您的系统上安装和配置 CCW。
## 前置要求
安装 CCW 之前，请确保您有：
- **Node.js** >= 18.0.0
- **npm** >= 9.0.0 或 **yarn** >= 1.22.0
- **Git** 用于版本控制功能
## 安装 CCW
### 全局安装（推荐）
```bash
npm install -g @ccw/cli
```
### 项目特定安装
```bash
# 在您的项目目录中
npm install --save-dev @ccw/cli
# 使用 npx 运行
npx ccw [命令]
```
### 使用 Yarn
```bash
# 全局
yarn global add @ccw/cli
# 项目特定
yarn add -D @ccw/cli
```
## 验证安装
```bash
ccw --version
# 输出: CCW v1.0.0
ccw --help
# 显示所有可用命令
```
## 配置
### CLI 工具配置
创建或编辑 `~/.claude/cli-tools.json`：
```json
{
"version": "3.3.0",
"tools": {
"gemini": {
"enabled": true,
"primaryModel": "gemini-2.5-flash",
"secondaryModel": "gemini-2.5-flash",
"tags": ["分析", "调试"],
"type": "builtin"
},
"codex": {
"enabled": true,
"primaryModel": "gpt-5.2",
"secondaryModel": "gpt-5.2",
"tags": [],
"type": "builtin"
}
}
}
```
### CLAUDE.md 指令
在项目根目录创建 `CLAUDE.md`：
```markdown
# 项目指令
## 编码标准
- 使用 TypeScript 确保类型安全
- 遵循 ESLint 配置
- 为所有新功能编写测试
## 架构
- 前端: Vue 3 + Vite
- 后端: Node.js + Express
- 数据库: PostgreSQL
```
## 更新 CCW
```bash
# 更新到最新版本
npm update -g @ccw/cli
# 或安装特定版本
npm install -g @ccw/cli@latest
```
## 卸载
```bash
npm uninstall -g @ccw/cli
# 删除配置（可选）
rm -rf ~/.claude
```
::: info 下一步
安装完成后，查看[第一个工作流](./first-workflow.md)指南。
:::