语法和标点符号

常见风格和用法，以及常见错误

Ansible

写“Ansible”。不要写“Ansible, Inc.”或“AnsibleWorks”。只有在编写法律或财务声明时除外。
在正文中不要单独使用徽标。始终保持与句子其余部分相同的字体。
在美国，一家公司是单数形式。换句话说，Ansible 是“它”，而不是“它们”。

大写

如果不是 Ansible 的真实产品、服务或部门，就不要大写。即使它看起来很重要也不要大写。标题中只有第一个单词的第一个字母大写。

冒号

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

但如果列表是句子中某个元素的补语或宾语，则不使用冒号：- 出行前，请务必（1）设置闹钟，（2）取消报纸，（3）请邻居收取您的邮件。

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

打开终端。

输入 cd…

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

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

连接名称

数量

每件物品的成本

逗号

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

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

这样更容易阅读，也有助于避免混淆。您会看到的主要例外是在 PR 中，传统上不使用串行逗号，因为这通常是记者的风格。

逗号非常重要，请考虑以下两个语句的巨大含义差异。

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

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

如果您不相信，也许这样可以。

缩写

在 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.

感叹号 (!)

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

性别代词

在文档中不要使用性别特指代词。阅读使用“他们”和“他们的”而不是“他/她”和“他的/她的”的句子要少得多尴尬。

在给出说明时使用“您”，在更一般的解释中使用“用户”、“新用户”等是没问题的。

在编写技术文档时，不要用“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 日访问”。

月份：一月、二月、三月、四月、五月、六月、七月、八月、九月、十一月、十二月。

州：阿拉巴马州、亚利桑那州、阿肯色州、加利福尼亚州、科罗拉多州、康涅狄格州、特拉华州、佛罗里达州、佐治亚州、伊利诺伊州、印第安纳州、堪萨斯州、肯塔基州、路易斯安那州、马里兰州、马萨诸塞州、密歇根州、明尼苏达州、密西西比州、密苏里州、蒙大拿州、内布拉斯加州、内华达州、新罕布什尔州、新泽西州、新墨西哥州、纽约州、北卡罗来纳州、北达科他州、俄克拉荷马州、俄勒冈州、宾夕法尼亚州、罗德岛州、南卡罗来纳州、南达科他州、田纳西州、佛蒙特州、弗吉尼亚州、华盛顿州、西弗吉尼亚州、威斯康星州、怀俄明州。

数字

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

电话号码

电话号码格式：1 (919) 555-0123 x002 和 1 888-GOTTEXT

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

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

除了少数例外情况，只使用“said”或“says”，因为其他任何东西只会妨碍引号本身，并且还会带有倾向性。

在引号后首先放置姓名: “我喜欢以第一人称写作，因为我喜欢成为我正在创作的角色，”沃利·兰姆说。
不是: “我喜欢以第一人称写作，因为我喜欢成为我正在创作的角色，”沃利·兰姆说。

分号

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

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

在连接副词（但是、因此、否则、即、例如，等等）之前使用分号：- 我思故我在。

句子后的空格

在句子后只使用一个空格。

时间

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