语法和标点符号

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

Ansible

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

大写

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

冒号

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

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

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

打开终端。

键入 cd…

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

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

连接名称

数量

每件商品的成本

逗号

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

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

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

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

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

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

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

缩写

在 Ansible 文档中不要使用缩写。

em 破折号

尽可能地使用 em 破折号，两侧不留空格。如果无法使用完整的 em 破折号，则使用双破折号，两侧不留空格 - 就像这样。

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

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

注意

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

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 日访问”。

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

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

数字

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

电话号码

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

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

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

除了极少数情况外，只使用“said”或“says”，因为其他任何东西都会妨碍引号本身，而且还会带有评论性质。

将姓名放在引号后的第一个位置: “我喜欢用第一人称写作，因为我喜欢成为我正在创作的角色，”Wally Lamb 说。
不是: “我喜欢用第一人称写作，因为我喜欢成为我正在创作的角色，”Wally Lamb 说。

分号

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

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

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

句子后的空格

句子后只使用一个空格。

时间

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