基本规则

使用标准美式英语

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

面向全球受众撰写

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

遵循命名约定

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

使用清晰的句子结构

清晰的句子结构意味着

• 首先给出重要的信息。

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

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

一些改进句子的例子

错误的

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

更好的

危险！远离悬崖。

错误的

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

更好的

提取也需要大量的水。

避免冗长

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

• “…正如之前所说，”

• “..每一个，”

• “…某个时间点，”

• “…为了，”

突出显示菜单项和命令

在记录菜单或命令时，将重要的内容用粗体表示会有所帮助。

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

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

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

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

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

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

.. code-block:: bash

  ssh my_vyos_user@vyos.example.net
  show config