语音风格

Ansible 写作风格的精髓在于短句,自然流畅地连接在一起。混合句子结构。改变句子主语。直接与读者对话。问一个问题。当读者适应了短句的节奏后,再写一个长句。

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

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

  • 用简单的词语表达重要的事情。

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

  • 诚实。

  • 短句显示自信。

  • 语法规则是为了打破的,但只有在读者知道你在这样做的时候才打破。

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

  • 将复制视为一对一的对话,而不是演讲。更难忽略直接与你说话的人。

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

主动语态

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