Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 3.88 KB

voice-tone.md

File metadata and controls

55 lines (36 loc) · 3.88 KB

语音和语调准则

开发人员通过阅读你的文档可以了解 .NET Core 的相关知识,他们在日常工作中也要时常参考其中的内容。 你的目标是创建有用的文档,帮助读者进行学习。 我们的准则帮助你实现目标。 风格指南包含四个建议:

阅读此风格指南时,可看到每个准则的示例。 本指南正是按照这些准则编写的,在你编写 .NET Core 文档时,不妨将本指南当做一个示例。 我们还提供了对比示例,通过这些例子,你可以了解不按照我们的准则编写的文章风格如何。

每条准则的详细信息

使用对话式语气

恰当的风格:

我们希望文档采用对话式语气。 当你阅读我们的教程或说明时,感觉就好像在和作者面对面交谈。 你会觉得这些文章读起来朗朗上口,毫无官腔而又内容详实。 感到自己正倾听作者向你解释概念。

不恰当的风格:

对话式风格与技术主题方面的学术式探讨是迥然不同的。 学术资源非常有用,不过作者在写那些文章时采用的风格与我们的风格全然不同。 当某人阅读学术期刊时,会发现非常不一样的语调和书写风格。 觉得他们在阅读非常枯燥的主题。

上面第一段符合我们建议的对话式风格。 第二段更具有学术性。 立即可看到两者区别。

以第二人称编写

恰当的风格:

如同直接和读者说话那样编写你的文章。 你应经常使用第二人称(就像我在这两句中使用的一样)。 第二人称并不总是意味着使用“你”。 直接写给读者。 使用祈使句。 告诉读者你希望他们了解什么。

不恰当的风格:

作者还可以选择以第三人称编写。 这种风格中,当提到读者时作者必须使用某个代词或名词。 读者可能常常发现这种第三人称风格不那么有趣,读起来不那么舒服。

第一段遵循我们推荐的风格。 第二段使用第三人称。 请使用第二人称编写。 你可能发现这样更易于阅读。

使用主动语态

使用主动语态写文章。 主动语态意味着句子的主语是句子中动作(谓词)的执行者。 被动语态与之不同,它的句子是按照主语是动作的接受者来排列的。 比较以下两个示例:

编译器将源代码转换为可执行文件。

源代码被编译器转换为可执行文件。

第一个句子使用主动语态。 第二个句子使用被动语态。 (这两个句子提供上述风格的又一示例)。

我们建议使用主动语态,因为它读起来更通顺。 被动语态读起来不那么顺口。

面向第五级阅读水平

我们最后提供了这个准则,因为许多读者的母语不是英语。 你的文章将面向国际受众。 请考虑他们可能不懂你知道的英语词汇。

但仍记住,你是为技术专业人员编写文章。 可以假定读者具有编程知识和特定的编程术语词汇表。 面向对象的编程、类、对象、函数和方法都是熟悉的术语。 但是,并非所有读者都具有正式的计算机科学学位。 如果使用诸如“幂等”的术语,则需要对其进行定义:

Close() 方法是幂等的,这表示可以多次调用它,其效果和调用一次相同。