基本规则

使用标准美式英语

Ansible 使用标准美式英语。注意美式英语中常见的拼写差异（例如 color vs colour, organize vs organise 等）。

面向全球受众编写

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

遵循命名约定

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

使用清晰的句子结构

清晰的句子结构意味着

• 首先用最重要的信息开头。

• 避免填充/添加额外的单词，这些单词会使句子更难理解。

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

一些改进句子的示例

不好

在悬崖边缘附近行走的人可能会发生危险的坠落，因此建议保持安全距离以确保人身安全。

更好

危险！远离悬崖。

不好

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

更好

提取过程也需要大量水。

避免冗长

写短小精悍的句子。避免使用以下术语：

• “…如前所述，”

• “..每一个，”

• “…时间点，”

• “…为了，”

突出显示菜单项和命令

在记录菜单或命令时，将重要内容 **加粗** 会有所帮助。

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

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

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

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

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

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

.. code-block:: bash

  ssh [email protected]
  show config