mirror of
https://github.com/yeasy/docker_practice.git
synced 2026-03-11 04:14:38 +00:00
Fix format issue
This commit is contained in:
27
16_appendix/16.5_editorial_style.md
Normal file
27
16_appendix/16.5_editorial_style.md
Normal file
@@ -0,0 +1,27 @@
|
||||
## 16.5 出版清稿规范(图号与章节风格)
|
||||
|
||||
本规范用于最终出版前清稿,确保全书图号、图题、章节结构与行文风格一致。
|
||||
|
||||
### 图号与图题规范
|
||||
|
||||
1. 图号格式统一为:`图 <章号>-<序号> <图题>`,例如 `图 10-2 Rails + PostgreSQL 的 Compose 架构`。
|
||||
2. 图号在同一章内按出现顺序连续编号,不重复、不跳号。
|
||||
3. 正文引用图片统一写法:`如图 <章号>-<序号> 所示`,不使用“下图/上图/示意图如下”。
|
||||
4. 所有图片必须提供有意义的 alt 文本,不使用空 alt(``)。
|
||||
5. 图题单独成行,放在图片下方。
|
||||
|
||||
### 章节风格规范
|
||||
|
||||
1. 小节标题统一使用编号体例:`## 10.6 ...`、`### 步骤 1:...`。
|
||||
2. 步骤型内容统一使用“步骤 N:”中文格式,不使用 `Step N:`。
|
||||
3. 命令行示例统一以 `bash` 代码块展示,提示符统一为 `$`。
|
||||
4. 关键提醒统一使用引用块(`> 注意/提示/警告`),避免正文中混杂多种强调样式。
|
||||
5. 章节内术语使用需遵循《[术语词表(出版统一版)](16.4_terminology.md)》。
|
||||
|
||||
### 出版前自检清单
|
||||
|
||||
1. 是否仍存在“下图/上图/示意图如下”等相对指代。
|
||||
2. 是否存在未编号或编号冲突的图题。
|
||||
3. 是否存在 `kubernetes`、`compose` 等正文大小写不统一写法。
|
||||
4. 是否存在 `Step N:` 与“步骤 N:”混用。
|
||||
5. 是否存在未加反引号的命令、文件名和配置键名。
|
||||
Reference in New Issue
Block a user