章节模板与语言风格统一记录

本文件记录本轮“统一章节模板与语言风格”的执行情况。

1. 执行范围

本轮处理范围:

book/01-why-agent.md
...
book/23-java-spring-agent-framework.md
book/_chapter-template.md
docs/chapter-style-guide.md

前言 book/00-preface.md 不强制使用普通章节模板,但已在前一轮完成图文融合。

2. 已完成改动

2.1 为第 1~23 章添加统一“本章导读”

每章标题后统一增加:

> **本章导读**  
> - 核心问题:...  
> - 关键词:...  
> - 学习产出:...

目的:

  • 让读者进入章节前先知道本章工程问题;
  • 统一章节开场节奏;
  • 将章节内容和贯穿案例建立直接关系。

2.2 统一章节元信息

检查并补齐:

所属部分
对应文章 / 工程来源
官方链接
本章状态:精修稿

其中第 1 章补充了缺失的:

本章状态:精修稿

2.3 统一 Markdown 层级

将非代码块中的二级小节从:

## 3.1 小节标题
## 任务 1:实践任务

统一调整为:

### 3.1 小节标题
### 任务 1:实践任务

这样每章层级变为:

# 章标题
## 一级章节结构
### 二级小节

本轮共调整 683 个小节标题。

2.4 处理重复贯穿案例

第 23 章原本已有编号化贯穿案例小节,又在前一轮自动插入了一个重复小节。

本轮已合并为一个:

## 7. 贯穿案例:CI 失败分析 Agent

并保留 Java / Spring Boot Framework 模块映射内容。

2.5 更新章节模板

已重写:

book/_chapter-template.md

新版模板包含:

  • 本章导读;
  • 章节元信息;
  • 对应 Anthropic 文章 / 工程来源;
  • 本章主图引用格式;
  • Java / Spring Boot 落地结构;
  • 贯穿案例要求;
  • 语言风格约定。

2.6 新增语言风格规范

新增:

docs/chapter-style-guide.md

规范内容包括:

  • 章节结构;
  • 本章导读格式;
  • 图示引用格式;
  • 贯穿案例写法;
  • 语言风格;
  • 术语规则;
  • Java / Spring Boot 写法;
  • 小结与实践任务写法。

3. 自动检查结果

本轮自动检查结果:

remaining H2 subsections: 0
guide missing: none
part missing: none
status missing: none
mainfig missing: none
case missing: none
summary missing: none
tasks missing: none

说明:

  • 第 1~23 章均已有“本章导读”;
  • 第 1~23 章均有所属部分、状态、主图、贯穿案例、小结和实践任务;
  • 非代码块中已无 ## 3.1 这类错误层级;
  • 第 23 章贯穿案例重复问题已修复。

4. 后续建议

下一轮可以进入“内容去重与一致性精修”:

  1. 检查每章已有“企业案例”与新增“贯穿案例”是否重复;
  2. 对重复段落进行合并;
  3. 检查每章小结是否包含本章核心工程结论;
  4. 检查实践任务是否都能独立完成;
  5. 准备附录模板,例如 AGENTS.md、Skill、ToolDefinition、MemoryRecord。

results matching ""

    No results matching ""