Ansible 文档风格指南

欢迎来到 Ansible 风格指南！为了在 docs.ansible.com 上创建清晰、简洁、一致和有用的资料，请遵循以下准则

语言指南 

我们希望 Ansible 文档具有以下特点：

清晰
直接
会话式
易于翻译

我们希望阅读文档的感觉就像有一位经验丰富、友好的同事解释 Ansible 的工作原理。

风格速查表 

此速查表说明了一些有助于实现“Ansible 语气”的规则

规则	好的例子	不好的例子
使用主动语态	你可以通过以下方式运行任务	任务可以通过以下方式运行
使用现在时	此命令创建一个	此命令将创建一个
与读者交流	当你扩展你的清单时	当受管节点的数量增长时
使用标准英语	返回此页面	跳回此页面
使用美式英语	输出的颜色	输出的颜色

标题和题头的大小写 

标题和题头应使用句子大小写。例如，本节的标题是 Title and heading case，而不是 Title and Heading Case 或 TITLE AND HEADING CASE。

避免使用拉丁语短语 

像 e.g. 或 etc. 这样的拉丁词汇和短语很容易被英语使用者理解。它们可能更难被其他人理解，并且对于自动翻译也很棘手。

请使用以下英语术语代替拉丁语术语或缩写

拉丁语	英语
即	换句话说
例如	例如
等	等等
通过	通过/通过
与/对比	而不是/对抗

reStructuredText 指南 

Ansible 文档使用 reStructuredText 编写，并由 Sphinx 处理。我们在所有 rST 页面上遵循这些技术或机械准则

标题标记 

reStructuredText 中的节标题可以使用多种标记。在创建标题层次结构时，Sphinx 会“动态学习”。为了使我们的文档易于阅读和编辑，我们遵循一套标准的标题标记。我们使用

### 带上划线，表示部分

###############
Developer guide
###############

*** 带上划线，表示章节

*******************
Ansible style guide
*******************

=== 表示节

Mechanical guidelines
=====================

--- 表示小节

Internal navigation
-------------------

^^^ 表示子小节

Adding anchors
^^^^^^^^^^^^^^

""" 表示段落

Paragraph that needs a title
""""""""""""""""""""""""""""

语法高亮 - Pygments 

Ansible 文档支持一系列 Pygments 词法分析器，用于语法高亮，使我们的代码示例看起来不错。每个代码块都必须正确缩进，并用空行包围。

Ansible 文档允许以下值

无（不突出显示）
ansible-output（用于 Ansible 输出的自定义词法分析器）
bash
控制台
csharp
ini
json
powershell
python
rst
sh
shell
shell-session
text
yaml
yaml+jinja

例如，你可以使用以下语法突出显示 Python 代码

.. code-block:: python

   def my_beautiful_python_code():
      pass

内部导航 

锚点（也称为标签）和链接协同工作，帮助用户查找相关内容。本地目录还可以帮助用户快速导航到他们需要的信息。所有内部链接都应使用 :ref: 语法。每个页面都应至少有一个锚点，以支持内部 :ref: 链接。长页面或具有多个标题级别的页面也可以包含本地目录。

注意

避免使用原始 URL。RST 和 sphinx 允许 https://my.example.com，但这对于使用屏幕阅读器的人来说没有帮助。:ref: 链接会自动从锚点获取标题，但对于外部链接，始终使用 `链接标题 <链接 URL>`_ 格式。

添加模块和插件的链接 

使用 :ansplugin: RST 角色，使用其完全限定的集合名称 (FQCN) 链接到模块和插件

The ansible.builtin.copy module can be linked with
:ansplugin:`ansible.builtin.copy#module`

If you want to specify an explicit type, use:
:ansplugin:`the copy module <ansible.builtin.copy#module>`

这将显示为“ansible.builtin.copy 模块可以使用 ansible.builtin.copy 链接”，以及“如果你想指定显式类型，请使用：copy 模块”。

除了 #module，你还可以指定 #<plugin_type> 来引用 <plugin_type> 类型的插件

:ansplugin:`arista.eos.eos_config <arista.eos.eos_config#module>`
:ansplugin:`kubernetes.core.kubectl connection plugin <kubernetes.core.kubectl#connection>`
:ansplugin:`ansible.builtin.file lookup plugin <ansible.builtin.file#lookup>`

注意

ansible.builtin 是 ansible-core 中包含的模块的 FQCN。

添加模块和插件选项以及返回值的链接 

使用 :ansopt: 和 :ansretval: 角色来引用模块和插件的选项和返回值

:ansopt:`ansible.builtin.file#module:path` references the ``path`` parameter of the
``ansible.builtin.file`` module; :ansopt:`ansible.builtin.file#module:path=/root/.ssh/known_hosts`
shows the assignment ``path=/root/.ssh/known_hosts`` as a clickable link.

:ansretval:`ansible.builtin.stat#module:stat.exists` references the ``stat.exists`` return value
of the ``ansible.builtin.stat`` module. You can also use ``=`` as for option values:
:ansretval:`ansible.builtin.stat#module:stat.exists=true` shows ``stat.exists=true``.

:ansopt:`foo` and :ansopt:`foo=bar` use the same markup for an option and an option
assignment without a link; the same is true for return values: :ansretval:`foo` and
:ansretval:`foo=bar`.

这显示为“path”引用了 ansible.builtin.file 模块的 path 参数；path=/root/.ssh/known_hosts 显示了赋值 path=/root/.ssh/known_hosts 作为可点击的链接。”和“stat.exists”引用了 ansible.builtin.stat 模块的 stat.exists 返回值。您还可以使用 = 来表示选项值：stat.exists=true 显示 stat.exists=true。”和“foo 和 foo=bar 使用相同的标记来表示一个选项和一个没有链接的选项赋值；对于返回值也是如此：foo 和 foo=bar。”

对于选项和返回值，. 用于引用子选项和包含的返回值。数组存根 ([...]) 可以用来表示某个东西是一个列表，例如 :retval: 参数 ansible.builtin.service_facts#module:ansible_facts.services['systemd'].state 引用了 ansible.builtin.service_facts 模块的 ansible_facts.services.state 返回值 (ansible_facts.services['systemd'].state)。

添加本地 TOC 

您正在阅读的页面包含一个本地 TOC。如果包含本地 TOC

请将其放在主标题和（可选的）介绍性文本的下方，而不是上方
使用 :local: 指令，这样页面的主标题就不会被包含在内
不要包含标题

语法是

.. contents::
   :local:

Markdown 指南 

一些 Ansible 生态系统文档是用 markdown 编写的，并由 mkdocs 处理。我们在所有 .md 页面上遵循这些技术或机械指南

标题表示法 

markdown 中的章节标题可以使用多种表示法。为了使我们的文档易于阅读和编辑，我们遵循一组标准的标题表示法。我们使用

# 表示页面标题

# Installation

## 表示章节标题

## Installing on Linux

子章节为每个子章节添加一个额外的 #。我们建议不要超过 ####，因为它表明文档嵌套很深，最好以多个页面的形式呈现。

在 Markdown 中链接 

使用 Mkdocs，可以使用本地文件的文件名而不是外部 URL 来格式化内部链接 <https://mkdocs.pythonlang.cn/user-guide/writing-your-docs/#writing-with-markdown>`_。

[configuration](/configuration)

您还可以直接链接到文件中的标题。使用标题的小写形式。

[dependency](/configuration/#dependency)

外部链接使用类似的格式，但使用外部 URL。

[Ansible Documentation](https://docs.ansible.org.cn)

代码块 

Markdown 支持以下格式的代码块。

```text
docs/
    index.md
    user-guide/getting-started.md
    user-guide/configuration-options.md
    license.md
```

可访问性指南 

Ansible 文档的目标是提高可访问性。请使用以下指南来帮助我们实现这一目标。

图像和替代文本 

确保所有图标、图像、图表和非文本元素都有有意义的替代文本描述。不要包含 CLI 输出的屏幕截图。请改用代码块。

在 rst 中添加 alt 文本

.. image:: path/networkdiag.png
   :width: 400
   :alt: SpiffyCorp network diagram

在 md 中添加 alt 文本

![SpiffyCorp network diagram](path/networkdiag.png)

链接和超文本 

URL 和交叉引用链接具有描述性文本，可以传达有关链接目标内容的信息。有关如何在 RST 中格式化链接，请参见内部导航，有关 Markdown，请参见在 Markdown 中链接。

表格 

表格具有从左到右、从上到下的简单逻辑阅读顺序。表格包含标题行，并避免空的或空白的表格单元格。用描述性标题标记表格。

对于 RST

.. table:: File descriptions

  +----------+----------------------------+
  |File      |Purpose                     |
  +==========+============================+
  |foo.txt   |foo configuration settings  |
  +----------+----------------------------+
  |bar.txt   |bar configuration settings  |
  +----------+----------------------------+

对于 Markdown

#### File descriptions

  |File       |Purpose                     |
  |---------- | -------------------------- |
  |foo.txt    | foo configuration settings |
  |bar.txt    | bar configuration settings |

颜色和其他视觉信息 

避免仅依赖感官特征的指令。例如，不要使用 单击方形的蓝色按钮继续。

通过方法而不是仅通过颜色传达信息。

确保图像和图表中的前景和背景文本或图形元素之间有足够的对比度。

在没有方向指示（如左、右、上和下）的情况下，浏览界面的说明是有意义的。

可访问性资源 

使用以下资源来帮助测试您的文档更改

axe DevTools 浏览器扩展 - 突出显示网站页面上的可访问性问题。
WebAIM 的 WAVE 浏览器扩展 - 另一个可访问性测试工具。
Orca 屏幕阅读器 - 视力障碍人士常用的工具。
颜色过滤器 - 用于色盲测试。