语法和标点符号

常用样式和用法以及常见错误

Ansible

书写“Ansible”。不要写“Ansible, Inc.”或“AnsibleWorks”。除非是法律或财务声明，否则均应遵循此规则。
切勿在正文中单独使用标识。始终保持与句子其余部分相同的字体。
在美国，公司是单数。换句话说，Ansible 是“它”，而不是“它们”。

大写

如果不是 Ansible 的真实产品、服务或部门，则不要大写。即使看起来很重要也不要大写。标题中只大写首字母。

冒号

冒号通常用于列表或系列之前：- 三角地区由三个城市组成：罗利、达勒姆和教堂山。

但如果列表是句子中某个元素的补语或宾语，则不需要使用冒号：- 出发度假前，请务必 (1) 设置闹钟，(2) 取消报纸订阅，(3) 请邻居代收邮件。

如果相关的列表紧跟其后，则在“如下”和“以下”之后使用冒号：更改目录的步骤如下：

打开终端。

键入 cd…

使用冒号来引入项目符号列表（或破折号，或您选择的图标/符号）

在“属性”对话框中，您将找到以下条目：

连接名称

计数

每项成本

逗号

使用序列逗号，即在三个或更多项目序列中的“and”之前使用逗号

“项目 1、项目 2 和项目 3。”

这样更容易阅读，也有助于避免混淆。您会看到的这个主要例外情况是公关稿件，其中传统上不使用序列逗号，因为这通常是记者的风格。

考虑到以下两个语句的含义差异巨大，逗号始终很重要。

让我们吃饭吧，奶奶
让我们吃奶奶。

正确的标点符号可以挽救奶奶的生命。

如果这不能说服你，也许这个可以：

缩写

Ansible 文档中不要使用缩写。

长破折号

如果可能，使用长破折号，两侧均不留空格。如果无法使用完整长破折号，则使用双破折号，两侧均不留空格——像这样。

一对长破折号可以代替逗号以增强可读性。但是，请注意，破折号总是比逗号更强调。

一对长破折号可以代替一对括号。破折号被认为不如括号正式；它们也更具侵入性。如果您想提请注意括号内容，请使用破折号。如果您想更巧妙地包含括号内容，请使用括号。

注意

当破折号代替括号时，应省略周围的标点符号。比较以下示例。

Upon discovering the errors (all 124 of them), the publisher immediately recalled the books.

Upon discovering the errors—all 124 of them—the publisher immediately recalled the books.

当在句末代替括号使用时，只使用一个破折号。

After three weeks on set, the cast was fed up with his direction (or, rather, lack of direction).

After three weeks on set, the cast was fed up with his direction—or, rather, lack of direction.

感叹号 (!)

不要在句尾使用它们。引用命令时可以使用感叹号，例如感叹号 (!) 命令。

性别指代

文档中不要使用特定性别的代词。使用“他们”和“他们的”比使用“他/她”和“他的/她的”更不容易让人感到别扭。

在给出指令时可以使用“您”，在更一般的解释中可以使用“用户”、“新用户”等等。

在编写技术文档时，切勿使用“one”代替“you”。使用“one”过于正式。

编写时不要使用“我们”。在用户方面，“我们”什么也没做。Ansible 的产品正在根据用户的请求完成工作。

连字符

连字符的主要功能是构成某些复合词。除非有必要，否则不要使用连字符。如果复合形容词不会被误读，或者像许多心理学术语一样，其含义已经确立，则不需要连字符。

使用连字符来避免歧义或混淆

a little-used car
a little used-car

cross complaint
cross-complaint

high-school girl
high schoolgirl

fine-tooth comb (most people do not comb their teeth)

third-world war
third world war

在专业印刷材料（特别是书籍、杂志和报纸）中，连字符用于在行尾和下一行开头之间分隔单词。这允许在右边缘均匀对齐，而不会出现高度可变（且分散注意力）的字距。

列表

保持项目符号列表的结构等效且一致。如果一个项目是动词短语，则所有项目都应是动词短语。如果一个项目是一个完整的句子，则所有项目都应是完整的句子，依此类推。

将每个项目的首字母大写。除非很明显它只是一个项目的列表，例如：* 电脑 * 显示器 * 键盘 * 鼠标

当项目符号列表出现在其他文本的上下文中时（除非它像前面的示例一样是简单的列表），即使项目是句子片段，也要添加句点。这样做的部分原因是每个项目都被认为完成了原始句子。

在某些情况下，项目符号独立出现，例如海报或主页推广，则不需要句点。

给出操作步骤时，使用编号列表而不是项目符号列表。

月份和州

根据美联社（AP）的规范缩写月份和州名。如果月份与日期一起使用，则仅缩写月份。例如：“总统于 1999 年 1 月访问。”或“总统于 1 月 12 日访问。”

月份：一月 (Jan.)、二月 (Feb.)、三月 (March)、四月 (April)、五月 (May)、六月 (June)、七月 (July)、八月 (Aug.)、九月 (Sept.)、十一月 (Nov.)、十二月 (Dec.)

州：阿拉巴马州 (Ala.)、亚利桑那州 (Ariz.)、阿肯色州 (Ark.)、加利福尼亚州 (Calif.)、科罗拉多州 (Colo.)、康涅狄格州 (Conn.)、特拉华州 (Del.)、佛罗里达州 (Fla.)、佐治亚州 (Ga.)、伊利诺伊州 (Ill.)、印第安纳州 (Ind.)、堪萨斯州 (Kan.)、肯塔基州 (Ky.)、路易斯安那州 (La.)、马里兰州 (Md.)、马萨诸塞州 (Mass.)、密歇根州 (Mich.)、明尼苏达州 (Minn.)、密西西比州 (Miss.)、密苏里州 (Mo.)、蒙大拿州 (Mont.)、内布拉斯加州 (Neb.)、内华达州 (Nev.)、新罕布什尔州 (NH)、新泽西州 (NJ)、新墨西哥州 (NM)、纽约州 (NY)、北卡罗来纳州 (NC)、北达科他州 (ND)、俄克拉荷马州 (Okla.)、俄勒冈州 (Ore.)、宾夕法尼亚州 (Pa.)、罗得岛州 (RI)、南卡罗来纳州 (SC)、南达科他州 (SD)、田纳西州 (Tenn.)、佛蒙特州 (Vt.)、弗吉尼亚州 (Va.)、华盛顿州 (Wash.)、西弗吉尼亚州 (W.Va.)、威斯康星州 (Wis.)、怀俄明州 (Wyo.)

数字

一到九之间的数字用文字表示。10 及以上用数字表示。例外情况是写“400 万”或“4 GB”。在表格和图表中使用数字也是可以接受的。

电话号码

电话号码样式：1 (919) 555-0123 分机 002 和 1 888-GOTTEXT

引号（使用引号和编写引语）

“将标点符号放在引号内，”编辑说道。

除非在极少数情况下，否则只使用“said”或“says”，因为其他任何东西都会妨碍引语本身，并且往往带有评论性质。

在引语后立即将姓名放在前面: “我喜欢用第一人称写作，因为我喜欢成为我正在创作的角色，”沃利·兰姆说道。
不是: “我喜欢用第一人称写作，因为我喜欢成为我正在创作的角色，”沃利·兰姆说。

分号

如果项目包含逗号，则使用分号分隔系列中的项目

我每天早餐吃咖啡、吐司和水果；午餐吃沙拉；晚餐吃花生酱三明治、饼干、冰淇淋和巧克力蛋糕。

在关联副词（例如 however、therefore、otherwise、namely、for example 等）之前使用分号：- 我思故我在。

句子后的空格

句子后只使用一个空格。

时间

一天中的时间写为“下午 4 点”。