Skip to content

Commit 1c3a4fe

Browse files
kimmyworkclaude
andcommitted
重写 Agentic AI 教程:扩展内容、新增章节、清理 AI 写作痕迹
- 重写全部 7 个章节,统一写作风格,去掉类比和模板化表达 - 新增 Agent 实践与治理章节(agent-practice.md) - 新增技术附录:API 调用与 Function Calling、RAG 技术详解 - intro.md 加入 Agent 四条标准定义、对齐定律、Prompting 基础地位 - ai-essentials.md 加入 Context Bloat/Mega-Prompt 反模式 - multimodal-creativity.md 加入图像生成演进、音频生成 - reasoning-logic.md 加入确认偏误、Human-in-the-loop、RAG 原理 - ai-coding.md 加入 Plan Mode、Ralph Loop、架构债务等局限性 - agentic-system.md 加入 Memory 机制、简化 MCP、动手练习 - agent-practice.md 加入 Multi-agent 实现模式、评估与调试、反模式汇总 - 更新 AGENTS.md 写作风格指南 - 更新 VitePress 侧边栏配置 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent a0165f5 commit 1c3a4fe

12 files changed

Lines changed: 1089 additions & 133 deletions

AGENTS.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,74 @@
1-
# 写作风格指南(基于 docs/chapters)
1+
# 写作风格指南
22

33
以下规则用于 AI 在本书中撰写或改写章节内容,保持与现有章节一致的写作风格与结构。
44

5+
本项目包含两个教程:
6+
- **编程导引**(docs/chapters)——JavaScript 编程入门
7+
- **Agentic AI**(docs/agentic-ai)——AI 协作与 Agent 实践
8+
59
## 语气与叙述
610

711
- 友好、耐心、口语化、引导式,但不幼稚、不俯视读者,也不把读者当成小孩子。
8-
- 常用提问引导思考(例如为什么会这样?”“那该怎么办?),语气保持专业与克制。
12+
- 常用提问引导思考(例如"为什么会这样?""那该怎么办?"),语气保持专业与克制。
913
- 先给直观解释,再给更严格的概念或结构化表述。
10-
- 允许轻量自我指代/引导(如“我们可以看到”“我们先看一个例子”)。
14+
- 允许轻量自我指代/引导(如"我们可以看到""我们先看一个例子")。
15+
- 不用类比来解释概念。直接用清晰的语言把概念说清楚,让一般读者也能理解。
1116

1217
## 概念呈现方式
1318

14-
- 先直觉/类比,再进入正式概念或定义。
19+
- 先直觉,再进入正式概念或定义。
1520
- 即便解释口语化,也尽量给出标准、严谨的术语和定义,避免误导。
16-
- 常用“短句总结 + 加粗关键词”的方式强调要点。
17-
- 中英术语并列出现,格式常为“中文(English)”或“中文 English”。
21+
- 中英术语并列出现,格式常为"中文(English)"或"中文 English"。
1822
- 不堆砌概念,控制密度与节奏。
23+
- 不用"短句总结"的固定模板。要点在正文中自然强调即可。
24+
- 加粗要克制。每个段落最多保留一个强调点,不要每个关键词都加粗。
1925

2026
## 章节结构与节奏
2127

2228
- 使用清晰的 Markdown 标题层级(# 章节、## 小节、### 子节)。
2329
- 每个小节围绕一个明确问题或概念展开。
2430
- 示例与解释交替出现,避免纯概念堆叠。
2531
- 常见收尾结构:
26-
- “小结/总结”
27-
- “练习”(列表形式,偏可操作)
28-
- 延伸阅读(链接到 reference 目录)
32+
- "小结"(每条控制在一句话以内)
33+
- "练习"(列表形式,偏可操作,一到四条为宜
34+
- "延伸阅读"(链接到 reference 目录)
2935

3036
## 示例与代码
3137

3238
- 以 JavaScript 为主,必要时可以用伪代码或其他语言对比,但需明确标注。
3339
- 代码块短小、可直接运行,示例名称尽量直观。
34-
- 代码前后给出简短解释,强调为什么这么写/会发生什么
40+
- 代码前后给出简短解释,强调"为什么这么写/会发生什么"
3541
- 允许用数学公式(LaTeX)辅助说明,但不应喧宾夺主。
3642

3743
## 格式与排版
3844

39-
- 关键术语用 **加粗**
40-
- 列表常用无序列表(* 或 -),用于“要点/原因/步骤”。
45+
- 列表常用无序列表(* 或 -),用于"要点/原因/步骤"。
4146
- 提醒/注释常用引用块(> 提醒:...)。
4247
- 强调差异或对比时使用短段落分隔。
4348

4449
## 读者假设
4550

4651
- 默认读者为零基础或初学者,尽量减少跳步。
47-
- 遇到容易误解/容易出错的点要显式提醒。
52+
- 遇到"容易误解/容易出错"的点要显式提醒。
4853
- 不制造焦虑,适当安抚读者,明确展示学习进步与里程碑。
4954

5055
## 链接与引用
5156

52-
- 延伸阅读集中链接到 `docs/reference`(或其子目录)下的概念条目。
57+
- "延伸阅读"集中链接到 `docs/reference`(或其子目录)下的概念条目。
5358
- 章节主体尽量少外链;必要外链放在首次出现处,且简短。
5459

5560
## 练习风格
5661

57-
- 练习题偏动手写/动手改,一到四条为宜。
62+
- 练习题偏"动手写/动手改",一到四条为宜。
5863
- 明确引导 Learn-by-doing,鼓励多动手、多尝试。
5964
- 引导发散思维,不局限于教程中给定的例子或解法。
6065
- 题目表述清晰,避免过度开放。
6166
- 与本章关键概念直接相关。
67+
68+
## Agentic AI 教程特有约定
69+
70+
- 核心概念(Prompting 基础、对齐定律、不要焦虑、技能>工具)在多个章节反复出现,但每次侧重不同,不做简单重复。
71+
- 反模式和最佳实践分散到各章节的相关位置讲,不在开头集中灌输。
72+
- 技术概念(MCP、Gateway、Memory 等)点到为止,配合一两个例子,不深入协议细节。
73+
- 动手练习不给具体代码,只描述实现步骤和目标,让读者自己写。
74+
- 附录(reference/)放技术细节较深的内容(RAG、API 调用),正文只讲原理和概念。

0 commit comments

Comments
 (0)