语音风格

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

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

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

  • 用简单的词表达深刻的含义。

  • 直截了当。告诉读者你确切地希望他们做什么。

  • 诚实。

  • 短句显示自信。

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

  • 选择音节更少的词,以加快阅读速度并提高理解力。

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

  • 尽可能用动词开头,编写任务导向的句子(指示用户执行操作的句子)。例如:查找软件… 联系支持… 安装媒体… 等等。

主动语态

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