语音风格

Ansible 写作风格的精髓在于使用流畅自然的短句。混合使用不同的句子结构。变换句子的主语。直接称呼读者。提出问题。当读者适应了短句的节奏后,再写一个长句子。

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

  • ……但尽量避免使用俚语和俗语,因为它们可能难以翻译成其他语言。

  • 用简单的词语表达重要的内容。

  • 直接一点。准确告诉读者你想让他们做什么。

  • 要诚实。

  • 短句显示出自信。

  • 语法规则是可以灵活变通的,但前提是读者知道你正在这样做。

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

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

  • 如果可能,以动作词开始面向任务的句子(那些指导用户做某事的句子)。例如:查找软件…联系支持…安装媒体…等等。

主动语态

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