语音风格
Ansible写作风格的核心是使用流畅自然的短句。混合使用不同的句子结构。变换句子的主语。直接与读者对话。提出问题。当读者适应了较短句子的节奏后,再写一些长句。
像真实的人一样写作……
……但尽量避免俚语和口语,因为它们可能难以翻译成其他语言。
用简单的词语表达复杂的概念。
直接了当。明确告诉读者你希望他们做什么。
诚实。
短句显示自信。
语法规则可以灵活运用,但前提是读者知道你在这么做。
选择音节较少的词语,以便更快地阅读和更好地理解。
将文档视为一对一的对话,而不是演讲。忽略直接与你对话的人更困难。
如果可能,以动词开头编写面向任务的句子(指示用户执行某项操作的句子)。例如:查找软件……联系支持……安装介质……等等。
主动语态
尽可能使用主动语态(“通过输入……启动Linuxconf”),而不是被动语态(“Linuxconf可以通过输入……启动”)。主动语态使阅读更生动有趣。同时,尽可能避免将来时(或使用“将”字)。例如,将来时(“屏幕将显示……”)不如主动语态(“屏幕显示……”)读起来流畅。记住,你为之写作的用户通常在使用系统时会参考文档,而不是使用系统之前或之后。