语音风格
Ansible 写作风格的精髓在于自然流畅的短句。混合句型。改变句子的主语。直接与读者对话。提出问题。当读者适应了短句的节奏后,写一个长句。
用真实的人的语言写作…
…但尽量避免俚语和口语,因为这些俚语和口语可能无法很好地翻译成其他语言。
用简单的词语表达深刻的含义。
直截了当。直接告诉读者你想让他们做什么。
诚实。
短句表现出自信。
语法规则是为了打破的,但只有在读者知道你在这样做的情况下。
选择音节更少的单词,以便更快地阅读和理解。
将内容视为一对一的对话,而不是演讲。忽视直接与你交谈的人更难。
如果可能,以动词开头任务导向的句子(指示用户执行操作的句子)。例如:查找软件……联系支持……安装媒体……等等。
主动语态
尽可能使用主动语态(“通过键入…启动 Linuxconf”),而不是被动语态(“Linuxconf 可以通过键入…启动”)。主动语态使阅读更生动有趣。还要避免将来时(或使用“将”这个词)。例如,将来时(“屏幕将显示…”)读起来不如主动语态(“屏幕显示…”)好。请记住,你正在为其撰写文档的用户通常是在使用系统时参考文档,而不是在使用系统之后或之前。