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