基本规则

使用标准美式英语

Ansible 使用标准美式英语。 注意美式英语中拼写不同的常见单词（color vs colour，organize vs organise 等）。

为全球受众写作

您所说的任何内容都应该能够被不同背景和文化的人理解。 避免使用习语和地域性表达，并保持不能被误解的中性语气。 避免幽默尝试。

遵循命名约定

始终遵循命名约定和商标。

使用清晰的句子结构

清晰的句子结构意味着

• 首先从重要的信息开始。

• 避免填充/添加使句子难以理解的额外单词。

• 保持简短 - 较长的句子难以理解。

一些改进句子的例子

坏

在悬崖边缘附近行走是不明智的，可能会导致危险的跌落，因此建议保持安全距离以维护人身安全。

好

危险！远离悬崖。

坏

此外，提取过程还需要大量的水。

好

提取还需要大量的水。

避免冗长

写简短、简洁的句子。 避免使用诸如

• “……如前所述，”

• “..每一个，”

• “……在某个时间点，”

• “……为了，”

突出显示菜单项和命令

在记录菜单或命令时，突出显示重要的内容会很有帮助。

对于菜单过程，请加粗菜单名称、按钮名称等，以帮助用户在 GUI 上找到它们

1. 在 文件 菜单上，单击 打开。

2. 在 用户名 字段中键入名称。

3. 在 打开 对话框中，单击 保存。

4. 在工具栏上，单击 打开文件 图标。

对于代码或命令片段，请使用 RST code-block 指令

.. code-block:: bash

  ssh [email protected]
  show config