Skip to content

Commit 1b1a1d6

Browse files
jnMetaCodejnMetaCode
committed
docs: 加 CHANGELOG（中英双语）+ README 加更新日志入口
- CHANGELOG.md / .en.md: 记录 2026-04 重大更新 新增模块（cheatsheet / pitfalls / scenarios / resources / CI） 修复汇总（角色数 / 模型名 / 锚点 / 措辞） Before / After 变化统计 - README 中英版新加"🆕 更新日志"小节指向 CHANGELOG 方便 GitHub 访客一眼看到项目最新进展。
1 parent da2d100 commit 1b1a1d6

4 files changed

Lines changed: 152 additions & 0 deletions

File tree

‎CHANGELOG.en.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
[简体中文](./CHANGELOG.md) | **English**
2+
3+
# Changelog
4+
5+
> See `git log` for full commit history. This file records user-facing major updates.
6+
7+
## 2026-04 · Major Update: From "Tool Tutorials" to "Full Hands-On Handbook"
8+
9+
### 🆕 New Modules
10+
11+
**📋 [Cheatsheet](cheatsheet.en.md) `cheatsheet.md`**
12+
- 9-tool × 13-dimension capability matrix
13+
- 30-second decision table (pick by need)
14+
- Each tool's config file location + core commands + hotkeys
15+
- Selection decision tree + 5 recommended combos
16+
17+
**⚠️ [Pitfalls Collection](pitfalls/README.en.md) `pitfalls/`**
18+
- **31 deep pitfalls** across 4 tools, each with "Symptom / Cause / Recovery / Prevention"
19+
- Claude Code (8) / Cursor (8) / GitHub Copilot (8) / Aider (7)
20+
- Windsurf / Gemini CLI / Kiro / Trae / OpenClaw — awaiting community contributions
21+
22+
**🎯 [Real-World Scenarios](workflows/scenarios.en.md) `workflows/scenarios.en.md`**
23+
- 3 end-to-end dialogue scripts: refactoring / Cursor+Claude Code collab / legacy test backfill
24+
- Universal "interrupt phrases" reference
25+
26+
**🧭 [Persona-Based Learning Paths](README.en.md) — Main README rewrite**
27+
- Reading paths recommended per 6 user personas (newcomer / frontend / backend / Copilot migrant / cost-sensitive / team collaboration)
28+
- Cheatsheet entry point at the top
29+
30+
**📚 [Further Learning Resources](resources.en.md) `resources.en.md`**
31+
- 20+ curated external resources across 7 categories (Prompt engineering / MCP / Agent / Chinese resources / blogs)
32+
- Each entry: link + scale + "when it's worth your time"
33+
34+
**🛡️ CI Guardrails `.github/workflows/link-check.yml`**
35+
- lychee scans all Markdown links (internal + external)
36+
- Bilingual parity check (every `xxx.md` must have `xxx.en.md`)
37+
- Weekly Monday cron to catch external link rot
38+
39+
**📝 [Contributing Guide](CONTRIBUTING.en.md) — rewritten + English version added**
40+
- Contribution types prioritized (pitfalls > tips > scenarios > fixes > translations)
41+
- New `CONTRIBUTING.en.md` English parallel
42+
43+
### 🔧 Fixes
44+
45+
- **agency-agents-zh role count 187 → 211** (12 references synced)
46+
- **Aider example model name `claude-3-5-sonnet` → `claude-sonnet-4-5`** (13 references)
47+
- **Copilot Pitfall 7 wording fix** ("silent degradation" → "queued or rejected")
48+
- **English README anchor fixes** (`#-9-tool-guides` → `#9-tool-guides`)
49+
- **English README newcomer recommendation**: Trae → Copilot/Cursor Free (international user fit)
50+
- **Cheatsheet removed unverifiable Esc Esc description**
51+
52+
### 📊 Before vs After
53+
54+
| Metric | Before | After |
55+
|--------|-------|-------|
56+
| Markdown files | ~42 | ~65 (+23) |
57+
| Bilingual parity | Partial | **100%** (templates excluded) |
58+
| CI workflows | 0 | 1 (link + bilingual) |
59+
| Pitfalls collection | 4-5 lines per README | 31 deep pitfalls |
60+
| Cheatsheet / decision page | None | `cheatsheet.md` |
61+
| Onboarding | Linear 3 steps | 6 persona paths |
62+
63+
---
64+
65+
## Before 2026-04
66+
67+
See `git log` for history. Early focus:
68+
69+
- 9 standalone tool READMEs
70+
- 7 universal methodologies (prompting / debugging / testing / etc.)
71+
- 3 multi-tool workflows
72+
- Bilingual initialization (most sections)
73+
- Copy-paste config templates

‎CHANGELOG.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 更新日志 · Changelog
2+
3+
> 完整提交历史见 `git log`。本文档记录面向用户的重要更新。
4+
5+
## 2026-04 · 重大更新：从"工具教程"到"完整落地手册"
6+
7+
### 🆕 新增模块
8+
9+
**📋 [速查表](cheatsheet.md) `cheatsheet.md`**
10+
- 9 工具 × 13 维度横向能力矩阵
11+
- 30 秒决策表（按需求选工具）
12+
- 每个工具的配置文件位置 + 核心命令 + 快捷键速查
13+
- 选型决策树 + 5 个推荐组合
14+
15+
**⚠️ [陷阱合集](pitfalls/) `pitfalls/`**
16+
- 4 个工具共 **31 个深度陷阱**，按 "症状 / 根因 / 出坑 / 预防" 四段式展开
17+
- Claude Code (8) / Cursor (8) / GitHub Copilot (8) / Aider (7)
18+
- Windsurf / Gemini CLI / Kiro / Trae / OpenClaw 待社区贡献
19+
20+
**🎯 [实战场景脚本](workflows/scenarios.md) `workflows/scenarios.md`**
21+
- 3 个端到端对话脚本：重构模块 / Cursor+Claude Code 协作 / 补老项目测试
22+
- 通用"打断话术"集锦
23+
24+
**🧭 [画像推荐路径](README.md) 主 README 重构**
25+
- 按 6 种用户画像推荐阅读路径（新手 / 前端 / 后端 / Copilot 迁移 / 控成本 / 团队协作）
26+
- 顶部加入速查表入口
27+
28+
**📚 [延伸学习资源](resources.md) `resources.md`**
29+
- 20+ 精选外部资源，分 7 类（Prompt 工程 / MCP / Agent / 中文资源 / 博客等）
30+
- 每条三要素：链接 + 量级 + "什么场景值得看"
31+
32+
**🛡️ CI 自动守护 `.github/workflows/link-check.yml`**
33+
- lychee 扫 Markdown 内外链接
34+
- 双语对照一致性校验（每个 `xxx.md` 必须有 `xxx.en.md`）
35+
- 每周一 cron 捕捉外链 rot
36+
37+
**📝 [贡献指南](CONTRIBUTING.md) 重写 + 英文版**
38+
- 明确贡献类型按优先级排序（陷阱 > 技巧 > 场景 > 修正 > 翻译）
39+
- 加 `CONTRIBUTING.en.md` 英文版
40+
41+
### 🔧 Fixes
42+
43+
- **agency-agents-zh 角色数 187 → 211**（12 处引用统一）
44+
- **Aider 示例模型名 `claude-3-5-sonnet` → `claude-sonnet-4-5`**（13 处）
45+
- **Copilot 陷阱 7 措辞修正**（"静默降级" → "排队或拒绝"）
46+
- **英文 README 锚点修复**（`#-9-tool-guides` → `#9-tool-guides`）
47+
- **英文 README 新手推荐工具**：Trae → Copilot/Cursor Free（国际用户适配）
48+
- **cheatsheet 删除无法确定的 Esc Esc 描述**
49+
50+
### 📊 变化统计
51+
52+
| 项目 | 更新前 | 更新后 |
53+
|------|-------|-------|
54+
| Markdown 文件数 | ~42 | ~65 (+23) |
55+
| 双语对照覆盖 | 部分 | **100%**（templates 除外） |
56+
| CI workflow | 0 | 1（link + bilingual） |
57+
| 陷阱合集 | 各 README 4-5 行速查 | 31 个深度展开 |
58+
| 速查 / 决策页 | 无 | cheatsheet.md |
59+
| 画像推荐 | 线性三步 | 6 种画像路径 |
60+
61+
---
62+
63+
## 2026-04 以前
64+
65+
参考 `git log` 查看历史。早期重点：
66+
67+
- 9 款工具独立 README
68+
- 7 套通用方法论（prompting / debugging / testing / etc.）
69+
- 3 个多工具协作工作流
70+
- 中英双语初始化（大部分章节）
71+
- 可复制的配置模板

‎README.en.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ Most AI coding resources fall into two camps: shallow "getting started" posts, o
123123

124124
This project covers "how to use the 9 tools well." Want to go deeper? See **[Further Learning Resources](resources.en.md)** — a curated list of **20+ high-quality GitHub repos / blogs / podcasts** organized by topic (Prompt Engineering / MCP Ecosystem / Claude Code Deep Dive / Agent Engineering / Chinese Resources / Official Blogs).
125125

126+
## 🆕 Changelog
127+
128+
See **[CHANGELOG](CHANGELOG.en.md)** for important updates. Latest major update: **2026-04** added cheatsheet, 31 deep pitfalls, end-to-end scenario scripts, persona-based learning paths, and 20+ external learning resources.
129+
126130
---
127131

128132
## Contributing

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,10 @@
130130

131131
本项目讲"怎么用好 9 款工具"，要继续深入推荐看 **[延伸学习资源](resources.md)**——精选了 **20+ 个高质量 GitHub 仓库 / 博客 / 播客**，按主题分类（Prompt 工程 / MCP 生态 / Claude Code 进阶 / Agent 工程 / 中文优秀资源 / 官方博客）。
132132

133+
## 🆕 更新日志
134+
135+
查看 **[CHANGELOG](CHANGELOG.md)** 了解项目重要更新。最近一次重大更新：**2026-04** 新增速查表、31 个深度陷阱合集、端到端实战脚本、画像推荐路径、20+ 外部学习资源。
136+
133137
---
134138

135139
## 致谢

0 commit comments

Comments
 (0)