技术英语 / 系统课时

统一大小写和标点格式

统一大小写和标点格式

技术文档进入发布前校对时,最容易留下的并不是语法错误,而是标题大小写、缩写、单位、列表结尾和标点风格前后不一。本节给出一套可执行的统一方法,让整篇文档在不改动技术含义的前提下保持一致。

学习目标

  • 为标题、术语、缩写、单位和列表确定统一的大小写规则
  • 识别标点与代码标记混用时最常见的格式问题
  • 用一份短检查清单完成发布前的一致性扫描

先确定一份可执行的风格规则

校对前先决定“采用哪一种写法”,否则只能不断凭感觉修改。规则不必复杂,但同一项目必须一致。比如标题可以统一采用 sentence case:只把首词、专有名词和必须保留大小写的技术名称大写,而不是每个实词都大写。

常见规则可以固定为以下几类:

对象 推荐做法 示例
标题 统一 sentence case 或项目既有风格 Configure the build cache
缩写 保留公认大写形式 API、HTTP、JSON
产品与语言名 使用官方写法 JavaScript、GitHub、macOS
标识符 完全保留源码大小写 userId、parseURL()
单位 数值与单位之间留空格,按项目约定处理例外 10 MB、250 ms
百分号 通常紧跟数值 95%

不要为了“视觉统一”擅自改写真实标识符。例如源码里是 userID,正文就不应因为偏好 userId 而替换;技术准确性优先于排版统一。

按对象逐类统一

标题先看层级内是否采用相同规则。若一级标题使用 sentence case,二级标题就不要突然出现 Title Case。相邻标题还要检查冒号、问号等结尾标点是否有明确用途,普通陈述型标题通常不需要句号。

列表需要统一的是“句子完整度”和结尾标点。完整句组成的列表可以统一加句号;短语列表可以统一不加句号。不要在同一列表里一项以句号结尾、另一项没有标点,除非内容结构确实不同。

缩写首次出现时,如果读者可能不熟悉,可以先写全称再给缩写,例如 “continuous integration (CI)”。后文继续用 CI 即可,不要一会儿写 Ci、一会儿写 ci。但命令、文件名和代码标识符仍以真实拼写为准。

处理代码标记与标点边界

行内代码只包住真实的技术字面量,不把周围自然语言标点一起包进去。例如应写“Run npm test.”,句号属于英文句子,不属于命令本身。

括号、冒号和逗号也遵循同样原则。代码标识符放在反引号内,说明性标点留在外部;如果技术内容本身包含标点,例如配置键 server.port,则标点属于标识符,应保留在反引号内。

涉及引号时,应先服从项目风格。技术文档常用直引号处理代码外的字符串说明,而真正的代码字符串仍应按语言语法写入代码块或行内代码,不要为了排版擅自更改源码引号。

发布前做一致性扫描

最后一轮不要再逐句润色,而是按对象扫描。先只看所有标题,再只看列表,再搜缩写、单位、产品名和高频技术词。这样比从头到尾通读更容易发现“不一致但不算错误”的细节。

可以用下面的顺序快速检查:

  1. 比较同级标题的大小写和标点。
  2. 检查同一列表内的句式和结尾标点。
  3. 搜索常见缩写,确认大小写一致。
  4. 搜索数字与单位,确认空格和单位写法一致。
  5. 检查行内代码边界,确认标点没有被误包进反引号。
  6. 最后再通读一遍,确认修改没有改变命令、文件名、API 名称或源码标识符。

统一格式的目标不是把所有文字变成同一种视觉形式,而是让读者能稳定地区分自然语言、技术标识符和结构层级。只要规则明确、技术字面量不被误改,文档的一致性就能在发布前被可靠控制。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

统一大小写和标点格式

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通