语音风格

Ansible 写作风格的精髓是简短的句子,它们自然地连贯在一起。混合使用句子结构。改变句子主语。直接与读者对话。提出问题。当读者适应较短的句子的节奏时,写一个较长的句子。

  • 用真实的人说话的方式写作……

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

  • 用小词说出大道理。

  • 直接一点。告诉读者你希望他们做什么。

  • 诚实。

  • 短句子表现出自信。

  • 语法规则是可以被打破的,但前提是读者知道你正在这样做。

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

  • 将文案视为一对一的对话,而不是演讲。直接和你说话的人更难被忽视。

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

主动语态

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