音调和语音指南

这是一个草案版本,我们希望通过社区反馈来改进它。

音调指一篇特定文章的情绪或态度。例如,你在个人电子邮件中的语气可能比你在工作中发送的更为非正式语音反映了文档之间不应发生太大变化的总体特征。WordPress及其社区的声音是友好但专业.

本指南主要针对英语文档。如果您不是用英语写作,请参阅您所在地区的指导方针.

语音

友好一点:在英语中,使用缩写(我是,不要)用第二人称写。使用目标受众可以使用的语言。避免使用行话。

要专业:以友好、通俗的方式写作时,一定不要写得过火。不要使用太多感叹号,也不要使用俚语或网络速记。写得简明扼要,尽可能使用主动语态。

一般来说,请记住文档被翻译成多种语言。重要的是要用一致的标准英语写作,避免文化参考和习语。例如,美国以外的用户可能不知道超级碗是什么,像“点你的I’s和交叉你的T’s”这样的表达很难翻译。

顶部

音调

顶部

用户文档

用户在文档中搜索问题的答案。保持友好、非正式的语调,但重点是清晰、简洁和非常准确。尽快开门见山。解释专业术语,但注意不要居高临下。为了确保清晰,首先简要说明当前主题的上下文。

请记住,许多用户不是以英语为母语的。避免冗长的叙述性段落。保持段落简短,重点突出,词汇和短语一致,便于所有读者理解。

描述WordPress管理员功能组件的示例:

好例子:

屏幕左侧是主屏幕导航菜单导航菜单 3.0版引入的主题功能。WordPress包含一个易于使用的机制,用于提供各种控制选项,让用户在站点上从一个位置单击到另一个位置。列出可以执行的管理功能。

错误的示例:

如果你往左边看,你会看到一个叫做主导航的菜单,这是主菜单。此菜单是管理员可以从管理屏幕执行的功能列表。

描述技术实现的示例:

好例子:

cookie是用于记忆有关您的信息的一小块数据。当你访问一个网站时,它会向你的浏览器发送一个cookie,而你的浏览器会将cookie存储在一个小文件中。下次你访问网站时,它会使用这个cookie来获取你喜欢的语言等信息。

错误的示例:

当你访问一个网站时,你可能想让网站记住一些关于你的信息,这样你就不必再给它信息了。网站可以向你的浏览器发送此类信息,以便日后记住你。这些信息被称为cookie。我知道你在想什么,饼干是你吃的东西,对吧?嗯,计算机cookie是不同的。这是网站使用的一点点数据,所以当你再次访问网站时,它会从cookie中收集信息,比如你说的是什么语言。

顶部

开发人员文档

开发人员经常在文档中搜索特定技术问题的答案。你的语气应该直接而准确。使用与用户文档相同的语调,但您可以假设读者具有更高水平的技术知识。在教程中,指定假定的技术知识很有帮助。

对于代码引用,请尽可能直接。对话的语气在这里不太合适。

好例子:

要检索选项,请使用get_option()函数。它接受两个参数:选项名称和选项不存在时要返回的默认值。

错误的示例:

有时你需要设置。如果使用get_option()函数并传入两个参数(参数是传递给函数的值),这很容易。一个参数是名称,另一个参数为默认值。

好例子:

#each:#each方法为数组中的每个元素调用一次提供的函数。它返回原始数组。

错误的示例:

接下来,让我们讨论每种方法。此方法为每个元素调用一个函数并返回一个数组。

上次更新时间: