基本规则

使用标准美式英语

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

面向全球受众编写

您所说的一切都应该让不同背景和文化的人理解。避免使用习语和地区性语言，并保持中立的语气，避免误解。避免尝试幽默。

遵循命名约定

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

使用清晰的句子结构

清晰的句子结构意味着

• 首先陈述重要信息。

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

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

一些改进句子的示例

错误的

在悬崖边缘附近区域不谨慎行走可能会导致危险坠落，因此建议保持安全距离以维护人身安全。

正确的

危险！远离悬崖。

错误的

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

正确的

提取也需要大量的水。

避免冗长

编写简短、简洁的句子。避免使用以下术语

• “…如前所述，”

• “..每一个，”

• “…某个时间点，”

• “…为了，”

突出显示菜单项和命令

在记录菜单或命令时，使用粗体突出显示重要内容很有帮助。

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

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

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

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

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

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

.. code-block:: bash

  ssh [email protected]
  show config