89e89d4aa3
Add Chinese (Simplified) translations for all documentation, organized under a dedicated zh/ directory that mirrors the English folder structure. Co-authored-by: tanqingkuang <tanqingkuang@users.noreply.github.com> Translations originally contributed by @tanqingkuang in #45. Restructured from *-CN.md suffix pattern into zh/ directory to prevent the EPUB builder (scripts/build_epub.py collect_folder_files) from picking up Chinese files via glob("*.md") inside module folders.
292 lines
12 KiB
Markdown
292 lines
12 KiB
Markdown
# 任务：双层知识库 - claude-howto
|
||
|
||
> 创建于：2026-04-01
|
||
|
||
---
|
||
|
||
## 里程碑
|
||
|
||
| # | 里程碑 | 目标时间 | 描述 |
|
||
|---|-----------|--------|-------------|
|
||
| M1 | 基础设施上线 | 2026 年 4 月底 | quickstart.sh、CLAUDE.md、staleness action、代理索引生成器上线；升级 2 个最薄弱模块 |
|
||
| M2 | 6/10 个模块完成 | 2026 年 6 月底 | Slash commands、memory、skills、CLI 模块完全升级；生成器输出有效 manifest |
|
||
| M3 | 10/10 个模块完成 | 2026 年 8 月底 | 每个模块都具备场景导语、Try It Now 模块、决策树、命名模式 |
|
||
| M4 | 代理层上线 | 2026 年 9 月底 | 生成 agent-manifest.json + AGENT-INDEX.md；仓库内有 lookup skill；`RECIPES.md` + `COMMUNITY-PROJECTS.md` 上线 |
|
||
| M5 | 版本审计完成 | 2026 年 11 月底 | 所有 10 个模块都验证过当前 CC 版本；`RECIPES.md` 达到 8+ recipes |
|
||
| M6 | 自我维持系统 | 2027 年 3 月底 | Agent manifest 覆盖 100% 模块（通过 CI 校验）；`RECIPES.md` 达到 10+；社区页面自然增长 |
|
||
|
||
---
|
||
|
||
## 第 1 阶段 - 基础设施与薄弱模块（2026 年 4 月）
|
||
|
||
**目标里程碑：M1**
|
||
|
||
### 支柱 4：新手上手
|
||
|
||
- [ ] **T-001** - 编写 `scripts/quickstart.sh`
|
||
- 检测 `~/.claude/` 目录（如缺失，则在用户确认后创建）
|
||
- 将第一个 slash command + CLAUDE.md + skill 复制到用户配置中
|
||
- 在 CLAUDE.md 末尾追加 agent-discovery 行，链接到 AGENT-INDEX.md
|
||
- 幂等：跳过已有文件并给出警告，绝不覆盖
|
||
- 完成后打印下一步
|
||
|
||
- [ ] **T-002** - 创建 `QUICKSTART.md`（前 15 分钟可视化指南）
|
||
- 使用代码块记录带注释的终端步骤（尽量避免 PNG 截图；优先 ASCII 或 Mermaid）
|
||
- 记录每条命令对应哪个视觉结果，方便后续重新采集
|
||
|
||
- [ ] **T-003** - 为所有 10 个模块的 README 添加难度徽章
|
||
- 格式：`> 🟢 **Beginner** | ⏱ 30 minutes`，放在每个模块 README 顶部
|
||
- 在徽章下方添加 "What you'll build" 的要点预览
|
||
|
||
### 支柱 7：活课程体系
|
||
|
||
- [ ] **T-004** - 创建 `WHATS-NEW.md`
|
||
- 格式：`## CC vX.X — DATE`，每个功能变更使用项目符号
|
||
- 至少添加一条当前 CC 版本的记录
|
||
|
||
- [ ] **T-005** - 为所有 10 个模块的 README 添加版本徽章
|
||
- 格式：`> ✅ Verified against Claude Code **vX.X.X** · Last verified: YYYY-MM-DD`
|
||
- 在每个模块的 frontmatter 中加入 `cc_version_verified`
|
||
|
||
- [ ] **T-006** - 创建 `.github/workflows/staleness-check.yml`
|
||
- 调度：每周一 09:00 UTC
|
||
- 从 frontmatter 读取每个模块的 `last_verified` 日期（使用 `yq` 或 10 行 Python 脚本）
|
||
- 对 30 天以上未验证的模块创建 GitHub Issue
|
||
- 如果已有同名 open issue，则跳过
|
||
|
||
### 支柱 6：内容质量（CLAUDE.md）
|
||
|
||
- [ ] **T-007** - 为项目创建根目录 `CLAUDE.md`
|
||
- 作为项目自身配置，展示最佳实践
|
||
- 记录贡献规范、模块结构和维护流程
|
||
|
||
### 支柱 2：AI 代理索引（生成器）
|
||
|
||
- [ ] **T-008** - 编写 `scripts/build-agent-index.py`
|
||
- 读取全部 10 个模块 README
|
||
- 提取：标题（→ topics）、代码块（→ 带语言标签的示例）、表格（→ 参考数据）
|
||
- 输出 `agent-manifest.json`，schema 按 CEO 计划定义
|
||
- 输出 `AGENT-INDEX.md`（人类可读摘要）
|
||
- 校验引用是否指向真实文件
|
||
|
||
### 模块 08-checkpoints：完整深度处理（311 → 800+ 行）
|
||
|
||
- [ ] **T-009** - 用真实场景重写模块导语
|
||
- 示例："你的重构把 3 个东西弄坏了。checkpoint 如何帮你恢复..."
|
||
|
||
- [ ] **T-010** - 添加 checkpoint 策略决策树（Mermaid flowchart）
|
||
- "我想做 X" → 顺着箭头走 → 到达对应 checkpoint 模式
|
||
|
||
- [ ] **T-011** - 添加 3 个工作流模板
|
||
- 安全重构工作流
|
||
- 使用 checkpoints 做 A/B 测试
|
||
- 灾难恢复工作流
|
||
|
||
- [ ] **T-012** - 添加与 planning mode 的整合部分
|
||
|
||
- [ ] **T-013** - 添加 checkpoint 生命周期的 Mermaid 图
|
||
|
||
- [ ] **T-014** - 添加 2 个以上 "Try It Now" 模块，并提供可验证命令
|
||
- 每个模块：上下文句、要运行的命令、预期输出说明
|
||
|
||
- [ ] **T-015** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
- 每个模式：问题、解决方案代码、适用场景、不适用场景
|
||
|
||
### 模块 06-hooks：完整深度处理
|
||
|
||
- [ ] **T-016** - 用真实场景重写模块导语
|
||
- 示例："你的 CI 在 20 分钟后才发现 lint 错误。hooks 2 秒内就能抓住..."
|
||
|
||
- [ ] **T-017** - 添加 hooks 决策树（Mermaid flowchart）
|
||
- "我想在 Y 发生时触发 X" → 顺着箭头走 → 到达对应 hook 类型
|
||
|
||
- [ ] **T-018** - 添加 5 个完整 hook 示例，带完整脚本（每个约 80 行）
|
||
1. 写入时自动格式化（prettier/black）
|
||
2. 提交时安全扫描（trufflehog/bandit）
|
||
3. 文件变更时运行测试
|
||
4. 会话结束时发送通知
|
||
5. 提示词校验（阻止危险模式）
|
||
|
||
- [ ] **T-019** - 添加 2 个以上 "Try It Now" 模块，并提供可验证命令
|
||
|
||
- [ ] **T-020** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
**M1 检查点：基础设施上线，2 个最薄弱模块完成深度升级**
|
||
|
||
---
|
||
|
||
## 第 2 阶段 - 深度处理：强模块第一批（2026 年 5 月 - 6 月）
|
||
|
||
**目标里程碑：M2**
|
||
|
||
### 模块 01-slash-commands：完整深度处理
|
||
|
||
- [ ] **T-021** - 用场景重写导语（"你的队友刚推了 47 个文件..."）
|
||
- [ ] **T-022** - 添加决策树（Mermaid）
|
||
- [ ] **T-023** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-024** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
### 模块 02-memory：完整深度处理
|
||
|
||
- [ ] **T-025** - 用真实场景重写导语
|
||
- [ ] **T-026** - 添加决策树（Mermaid）
|
||
- [ ] **T-027** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-028** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
### 模块 03-skills：完整深度处理
|
||
|
||
- [ ] **T-029** - 用真实场景重写导语
|
||
- [ ] **T-030** - 添加决策树（Mermaid）
|
||
- [ ] **T-031** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-032** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
### 模块 10-cli：完整深度处理
|
||
|
||
- [ ] **T-033** - 用真实场景重写导语
|
||
- [ ] **T-034** - 添加决策树（Mermaid）
|
||
- [ ] **T-035** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-036** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
### 生成器校验
|
||
|
||
- [ ] **T-037** - 每次模块升级后运行 `scripts/build-agent-index.py`；确认 manifest 输出有效
|
||
- [ ] **T-038** - 在每次 push 时添加 CI 步骤：校验 agent-manifest.json schema
|
||
|
||
**M2 检查点：6/10 个模块完成，生成器输出有效 manifest**
|
||
|
||
---
|
||
|
||
## 第 3 阶段 - 深度处理：强模块第二批（2026 年 7 月 - 8 月）
|
||
|
||
**目标里程碑：M3**
|
||
|
||
### 模块 04-subagents：完整深度处理
|
||
|
||
- [ ] **T-039** - 用真实场景重写导语
|
||
- [ ] **T-040** - 添加决策树（Mermaid）
|
||
- [ ] **T-041** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-042** - 添加 "Patterns & Recipes" 部分（例如："The Multi-Agent Review Pattern"）
|
||
|
||
### 模块 05-mcp：完整深度处理
|
||
|
||
- [ ] **T-043** - 用真实场景重写导语
|
||
- [ ] **T-044** - 添加决策树（Mermaid）
|
||
- [ ] **T-045** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-046** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
### 模块 07-plugins：完整深度处理
|
||
|
||
- [ ] **T-047** - 用真实场景重写导语
|
||
- [ ] **T-048** - 添加决策树（Mermaid）
|
||
- [ ] **T-049** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-050** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
### 模块 09-advanced-features：完整深度处理
|
||
|
||
- [ ] **T-051** - 用真实场景重写导语
|
||
- [ ] **T-052** - 添加决策树（Mermaid）
|
||
- [ ] **T-053** - 添加 2 个以上 "Try It Now" 模块
|
||
- [ ] **T-054** - 添加 "Patterns & Recipes" 部分，包含 2 个以上命名模式
|
||
|
||
**M3 检查点：全部 10 个模块完成且风格一致**
|
||
|
||
---
|
||
|
||
## 第 4 阶段 - 代理层与跨模块（2026 年 9 月）
|
||
|
||
**目标里程碑：M4**
|
||
|
||
### 支柱 2：最终完成 AI 代理索引
|
||
|
||
- [ ] **T-055** - 使用所有 10 个完成的模块运行 `scripts/build-agent-index.py`
|
||
- 生成最终版 `agent-manifest.json`，覆盖率达到 100%
|
||
- 生成 `AGENT-INDEX.md` 并从 `README.md` 链接
|
||
|
||
- [ ] **T-056** - 创建 `skills/claude-howto-lookup/SKILL.md`
|
||
- 读取 `agent-manifest.json` 以查找相关模块
|
||
- 使用 `Read` 加载对应章节
|
||
- 安装方式：`cp -r claude-howto/skills/claude-howto-lookup ~/.claude/skills/`
|
||
|
||
- [ ] **T-057** - 在 quickstart.sh 和 QUICKSTART.md 中把 lookup skill 作为可选功能提到
|
||
|
||
### 支柱 3b：跨模块 `RECIPES.md`
|
||
|
||
- [ ] **T-058** - 创建带有 5 个以上组合工作流的 `RECIPES.md`
|
||
- 每个 recipe 的 schema：name、modules-used、problem、solution 代码块、expected outcome
|
||
- 示例：skill + hook + subagent = 自动审查流水线
|
||
- 确保所有主要标题都有 HTML 锚点，便于深链
|
||
|
||
### 支柱 5：社区展示
|
||
|
||
- [ ] **T-059** - 创建 `COMMUNITY-PROJECTS.md`
|
||
- 静态 Markdown 页面，提交格式包括：name、description、link、features used
|
||
- 包含模板条目
|
||
- 提供基于 PR 的提交说明
|
||
|
||
**M4 检查点：代理索引上线，recipes 上线，社区页面上线**
|
||
|
||
---
|
||
|
||
## 第 5 阶段 - 版本审计与 recipe 扩展（2026 年 10 月 - 11 月）
|
||
|
||
**目标里程碑：M5**
|
||
|
||
- [ ] **T-060** - 进行完整版本审计：验证所有 10 个模块是否与当前 CC 版本匹配
|
||
- 更新每个模块的 `cc_version_verified` frontmatter
|
||
- 更新版本徽章
|
||
|
||
- [ ] **T-061** - 将 `RECIPES.md` 扩展到 8 个以上 recipes，基于社区实践模式
|
||
|
||
- [ ] **T-062** - 如果完成的模块中出现新的模式，则迭代 agent manifest schema
|
||
|
||
- [ ] **T-063** - 开一个置顶 GitHub Discussion："分享你的 Claude Code 工作流"
|
||
- 收集真实 agent 使用信号，为后续 recipe 扩展提供依据
|
||
|
||
**M5 检查点：所有模块都已验证当前版本，recipes 持续增长**
|
||
|
||
---
|
||
|
||
## 第 6 阶段 - 组合与持续运行（2026 年 12 月 - 2027 年 3 月）
|
||
|
||
**目标里程碑：M6**
|
||
|
||
- [ ] **T-064** - 每次 CC 发布后运行 `/docs-sync-claude-code` skill；更新 `WHATS-NEW.md`
|
||
|
||
- [ ] **T-065** - 确保 agent manifest 覆盖 100% 模块（CI 回归测试）
|
||
|
||
- [ ] **T-066** - 将 `RECIPES.md` 扩展到 10 个以上 recipes
|
||
|
||
- [ ] **T-067** - 监控 `COMMUNITY-PROJECTS.md` 的自然增长；筛选新增条目
|
||
|
||
- [ ] **T-068** - 评估来自 GitHub Discussions 的 agent 使用信号；如果验证有效，就投入资源推广 lookup skill（营销、asm registry）
|
||
|
||
**M6 检查点：系统已经可以自我维持**
|
||
|
||
---
|
||
|
||
## 延后项（TODOS.md）
|
||
|
||
这些内容不在本计划范围内。请记录在这里，避免范围蔓延：
|
||
|
||
- Skill marketplace / 可安装 registry
|
||
- 自定义网站或仪表盘
|
||
- 完成度追踪基础设施（cc-progress）
|
||
- 带 CI 校验的社区教程模板
|
||
- 自动生成的 CONTRIBUTORS.md
|
||
- 多语言翻译
|
||
- 测验 / 评估基础设施升级
|
||
- COMMUNITY-PROJECTS.md 的社区投票 / 审核机制
|
||
|
||
---
|
||
|
||
## 按阶段划分的任务摘要
|
||
|
||
| 阶段 | 任务 | 时间段 | 涉及模块 |
|
||
|-------|-------|--------|-----------------|
|
||
| 1 - 基础设施与薄弱模块 | T-001 到 T-020 | 2026 年 4 月 | 06-hooks、08-checkpoints + 基础设施 |
|
||
| 2 - 第一批深度处理 | T-021 到 T-038 | 2026 年 5 月 - 6 月 | 01、02、03、10 |
|
||
| 3 - 第二批深度处理 | T-039 到 T-054 | 2026 年 7 月 - 8 月 | 04、05、07、09 |
|
||
| 4 - 代理层与跨模块 | T-055 到 T-059 | 2026 年 9 月 | 全部（manifest）+ 新文件 |
|
||
| 5 - 版本审计与 recipes | T-060 到 T-063 | 2026 年 10 月 - 11 月 | 全部（审计） |
|
||
| 6 - 持续运行 | T-064 到 T-068 | 2026 年 12 月 - 2027 年 3 月 | 持续进行 |
|