语音风格

Ansible 编写风格的精髓是句子简短,自然流畅。混合使用句子结构。改变句子主语。直接与读者交谈。提出问题。当读者适应了短句的节奏后,再写一个长句。

  • 像真实的人说话一样写作…

  • …但尽量避免俚语和口语,因为这些词语可能无法很好地翻译成其他语言。

  • 用简单的词语表达深刻的道理。

  • 直接了当。准确地告诉读者你想让他们做什么。

  • 诚实。

  • 短句显示自信。

  • 语法规则是为了打破而存在的,但前提是读者知道你在这样做。

  • 选择音节较少的词语,以便更快地阅读和理解。

  • 将文档内容视为一对一的对话,而不是演讲。忽略与你直接交谈的人更难。

  • 在可能的情况下,以动词开头任务导向的句子(引导用户执行操作的句子)。例如:查找软件… 联系支持… 安装媒体… 等等。

主动语态

尽可能使用主动语态(“通过输入… 启动 Linuxconf”),而不是被动语态(“Linuxconf 可以通过输入… 启动”)。主动语态使阅读更生动有趣。此外,尽量避免使用将来时(或使用术语“将”)。例如,将来时(“屏幕将显示…”)不如主动语态(“屏幕显示…”)读起来好。请记住,你为其编写文档的用户通常是在使用系统时参考文档,而不是使用系统之后或之前。