写作风格

Ansible写作风格的核心是自然流畅的短句。 混合使用不同的句式,变换句子的主语,直接称呼读者,提出问题。当读者适应了短句的节奏后,再使用长句。

  • 像人们日常说话一样写作……

  • ……但尽量避免俚语和口语化表达,因为这些可能难以翻译成其他语言。

  • 用简单的词语表达复杂的概念。

  • 直接了当。准确告诉读者你想让他们做什么。

  • 真诚坦率。

  • 短句显示自信。

  • 语法规则可以灵活运用,但前提是读者知道你在这么做。

  • 选择音节较少的词语,使阅读速度更快,理解更容易。

  • 将文档写作视为一对一的对话,而不是演讲。直接与人对话更难以被忽略。

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

主动语态

尽可能使用主动语态(“键入……启动Linuxconf”),而不是被动语态(“Linuxconf可以通过键入……启动”)。主动语态使阅读更生动有趣。尽量避免将来时(或使用“将”字),例如,将来时(“屏幕将显示……”)不如主动语态(“屏幕显示……”)读起来流畅。记住,你所面向的用户通常是在使用系统时查阅文档,而不是使用系统之前或之后。