语音语调准则
各种读者(包括 IT 专业人员和开发人员)都会阅读 .NET 文档,为的是了解 .NET 并在其日常工作中运用它。 因此,你的目标就是要创建精美的文档,帮助读者实现这一过程。 而我们的准则就有助于实现这一目标。 我们的风格指南包含以下建议:
使用对话式语气
以下段落应采用对话式风格进行编写。 而实际采用的风格更偏向于学术风格。
适当的风格
我们希望文档采用对话式语气。 当你阅读任何教程或说明时,应感觉就像在与作者进行对话一样。 对你而言,体验应该是非正式的、对话式的,并且起告知作用。 读者应感觉似乎在聆听作者向他们介绍相关概念。
不当的风格
有人可能了解对话式风格与技术主题更具学术性处理的风格之间的对比。 这些资源非常有用,但作者采用与我们的文档截然不同的风格编写这些文章。 当读者阅读学术型杂志时,会发现截然不同的语气和截然不同的写作风格。 用户会感觉他们在读一份有关非常枯燥的主题的枯燥记录。
采用第二人称编写
以下段落应采用第二人称。 而实际采用的人称为第三人称。 请采用第二人称进行编写。
适当的风格
应采用似乎在直接对读者讲话的风格编写文章。 应经常使用第二人称(如在这两个句子中使用的一样)。 第二人称并不意味着始终使用单词“你”。 面向读者,直抒胸臆。 使用祈使句编写。 让读者直接感知到你希望告知他们的内容。
不当的风格
作者也可选择采用第三人称编写。 在该模型中,当作者指代读者时,必须找到一些代词或名称供使用。 读者可能经常发现这种第三人称风格缺少吸引力,也缺少阅读乐趣。
使用主动语态
采用主动语态编写文章。 主动语态指的是句子的主语执行该句中的操作(谓词)。 它与被动语态形成对比,在被动语态中,句子排列方式是使句子的主语作为操作的对象。 对比以下两个示例:
编译器将源代码转换为可执行文件。
源代码被编译器转换为可执行文件。
第一句使用的是主动语态。 第二句使用的是被动语态。 (上述两个句子为每种风格提供另一示例)。
建议使用主动语态,因为它更可读。 使用被动语态可能更难阅读。
为可能具有有限词汇的读者编写
你的文章受众遍布全球。 很多读者不是以英语为母语的人,可能不知道你所了解的英语词汇。
然而,你仍需等待技术专业人员。 可以假设读者具有编程知识和编程术语的特定词汇。 常用术语有“面向目标程序设计”、“类”、“对象”、“函数”和“方法”。 然而,并非所有阅读你文章的人都有计算机科学正式学位。 如果使用“幂等”之类的术语,可能需要进行定义,例如:
Close()
方法是幂等的,表示可多次对其调用,并且效果与调用一次相同。
避免将来时态
在某些非英语语言中,将来时态的概念与英语中是不同的。 使用将来时态,可能使文档难以阅读。 此外,如果使用将来时态,会存在一个很明显的问题,即什么时候。 因此,如果你说“学习 PowerShell 将对你有益” - 对于读者,很明显的问题是什么时候有益? 相反,直接说“学习 PowerShell 对你有好处”即可。
是什么 - 那又怎样?
每当向读者介绍新概念时,定义概念且只需说明为什么有用。 在了解某事物益处(或者诸如此类)之前,读者有必要了解它是什么。