Add number to section names

This commit is contained in:
Baohua Yang
2026-02-22 08:37:51 -08:00
parent 185da0cf88
commit b9ac198f19
17 changed files with 98 additions and 161 deletions

View File

@@ -1,35 +0,0 @@
## 术语词表 (出版统一版)
本词表用于统一全书术语缩写和命令表达适用于最终出版前清稿
### 核心术语统一表
相关信息如下表
| 统一写法 (推荐)| 可接受写法 | 避免写法 | 说明 |
|---|---|---|---|
| Docker Engine | Docker 引擎 | docker engine | 产品名首字母大写 |
| Docker Desktop | - | docker desktop | 产品名首字母大写 |
| Dockerfile | - | Docker Filedockerfile | 固定拼写 |
| Docker 镜像 (Image)| 镜像 | image (纯英文散落)| 首次出现建议中英文并列 |
| Docker 容器 (Container)| 容器 | container (纯英文散落)| 与镜像区分清楚 |
| 仓库 (Repository)| Repo (非正式)| 镜像仓库/Repository 混用不解释 | 首次出现需给出英文 |
| 注册服务器 (Registry)| 镜像注册服务 | 私有仓库/Registry 混指 | Registry Repository 需区分 |
| 标签 (Tag)| 版本标签 | tag (正文中小写裸写)| 命令中保留原样 |
| Docker Compose | Compose | docker compose (当作产品名)| 产品名用 `Docker Compose` |
| `docker compose` | - | `docker-compose` (新示例中)| 命令统一使用 V2 子命令写法 |
| `compose.yaml` | `compose.yml` | 新示例继续使用 `docker-compose.yml` | 教学默认文件名统一为 `compose.yaml` |
| Kubernetes | K8s (缩写)| kubernetes (正文)| 正文统一首字母大写 |
| `kubectl` | - | kubeclt (拼写错误)| 命令与二进制名用反引号包裹 |
| etcd | - | Etcd (混用)| 项目官方写法为小写 `etcd` |
| Docker Buildx | Buildx | buildx (正文裸写)| 产品名用 `Docker Buildx` |
| BuildKit | - | buildkit | 固定大小写 |
| 控制平面 (Control Plane)| - | 主控平面 (未定义)| 章节内保持单一译名 |
| 工作节点 (Worker Node)| 节点 (在上下文明确时)| 工作机器 (未定义)| 与控制平面对照使用 |
### 清稿执行规则
1. 术语首次出现采用 中文 (英文) 格式例如 注册服务器 (Registry)
2. 命令文件名配置键统一使用反引号包裹
3. 同一章节中术语只保留一种主写法不混用同义词
4. 若引用历史名词 ( `docker-compose.yml`)需显式标注 历史文件名

View File

@@ -1,27 +0,0 @@
## 出版清稿规范 (图号与章节风格)
本规范用于最终出版前清稿确保全书图号图题章节结构与行文风格一致
### 图号与图题规范
1. 图号格式统一为`图 <章号>-<序号> <图题>`例如 `图 10-2 Rails + PostgreSQL 的 Compose 架构`
2. 图号在同一章内按出现顺序连续编号不重复不跳号
3. 正文引用图片统一写法`如图 <章号>-<序号> 所示`不使用 下图/上图/示意图如下
4. 所有图片必须提供有意义的 alt 文本不使用空 alt (`![图](...)`)
5. 图题单独成行放在图片下方
### 章节风格规范
1. 小节标题统一使用编号体例`## 10.6 ...``### 步骤 1...`
2. 步骤型内容统一使用 步骤 N 中文格式不使用 `Step N:`
3. 命令行示例统一以 `bash` 代码块展示提示符统一为 `$`
4. 关键提醒统一使用引用块 (`> 注意/提示/警告`)避免正文中混杂多种强调样式
5. 章节内术语使用需遵循[术语词表 (出版统一版)](20.4_terminology.md)
### 出版前自检清单
1. 是否仍存在 下图/上图/示意图如下 等相对指代
2. 是否存在未编号或编号冲突的图题
3. 是否存在 `kubernetes``compose` 等正文大小写不统一写法
4. 是否存在 `Step N:` 步骤 N 混用
5. 是否存在未加反引号的命令文件名和配置键名