复制指导原则

更长的文本

编写多行/步骤说明或叙述性介绍/页面或功能定位的指南。

这显然会因上下文而异,但以下是一些一般提示:

第一:收缩是你的朋友!

它们更具对话性,是一种使文本听起来更友好、更不正式的简单方法。(而且它们还节省了一点空间:双赢。)

第二:删掉那些夸大字数却没有真正意义的短语。

这在两个特定的实例中经常发生。首先,用被动语态写作时:

此块可用于显示单个图像。

每当你看到“可以”或“被使用”这样的短语时:停止。你在用被动语态写作。尝试用一个更敏捷(更短)的句子:

此块显示单个图像。

其次,当我们进行对冲而不是进行声明性陈述时,就会发生这种情况:

图库块可以帮助您以优雅的布局显示多幅图像。

是不是?我们正在制作这个软件:我们被允许声明它是什么和做什么:

图库块以优雅的布局显示多幅图像。

我们也经常用短语“允许你这样做”来表达这一点

预设格式的文本允许您保留制表符和换行符。

功能不允许任何人做任何事情;它们只是做特定事情以达到目的的工具。只需说出他们所做的:

预设格式的文本会保留制表符和换行符。

更直接的句子几乎总是更清晰。扫描你的副本,寻找单词“可以”、“是”、“可能”、“允许你”和“帮助”——它们是最常见的罪魁祸首,而专门寻找这些单词是一种找到你可以收紧的短语的方法。

第三:小心“简单”、“简单”和“公正”

简单的事情不是由我们来决定的:而是由用户来决定。如果我们说一些事情很简单,而用户没有一个简单的体验,这会破坏他们对我们和我们正在建设的东西的信任。“just”也是如此,我们中的许多人都知道要避免使用“simple”,但仍然会一直使用“just“。“只需点击这里。”“只需输入用户名。”这是同一件事:它意味着某些事情不会有什么大不了的,但我们不知道用户会发现什么是大不了的。

具体一点也更安全,更有帮助。“简单”和“简单”是我们还没有写过的解释的缩写;每当你看到他们,花点时间想想他们代表什么。也许“通过点击‘enter’很容易添加一个块”实际上意味着“你可以在不离开键盘的情况下向页面添加更多内容。”太棒了!说出具体的事情,而不是依赖于“简单”

这并不是说你应该把这些单词从你的词汇中剔除。你可能想写一个工具提示来描述封面图像块现在如何需要更少的配置,或者写一封关于我们如何构建一个用于快速创建自定义块的工具的电子邮件,你可以合理地说封面图像块已经被简化,或者我们正在努力使自定义块的创建更容易,这些术语具有描述性和相对性。但要注意你可能使用(或过度使用)它们的方式,以绝对地宣称某件事很容易或很简单,并将其作为更具体、更清晰的机会。

第四:注意“我们”

任何时候,文本或指令经常使用“我们”,这意味着文本的重点是软件背后的人,而不是软件的使用者。有时这是你真正想要的,但通常不是。重点通常应该放在用户、他们需要什么以及他们如何受益,而不是“我们做了什么”或“我们想要什么”

我们是唯一关心自己做了什么或想要什么的人;用户只需要能正常工作的软件。如果你看到很多“我们”,想想你是否应该重新定义你写的东西,以关注用户的利益和成功。

项目符号列表

编写项目符号列表的指南。

第一:在所有项目符号中保持句子结构平行。

平行结构使列表更容易快速阅读——它们的可预测性减轻了读者的认知负担。

良好:

你能用这个木块做什么?很多事情!

  • 添加报价。
  • 突出显示链接。
  • 显示多个图像。
  • 创建项目符号列表。

每个项目符号都是一个完整的句子,以句号结尾。(如果你的列表是一堆一个或两个单词的项目,这些项目通常可以变成一个普通的句子-更容易阅读,节省空间。)每一行都以一个动词开头,告诉用户块可以做什么。句子的主语总是用户。

用户可以很快地理解这个列表,因为一旦他们阅读了第一项,他们就会理解如何阅读其余内容,并知道他们会找到什么信息。

不太好:

你能用这个方块做什么?很多事情!

  • 您可以添加报价。
  • 突出显示你喜欢的链接。
  • 它显示多个图像。很适合画廊!
  • 项目符号列表

这里,每一行都有不同的短语(有些以动词开头,有些以名词开头),句子的主语也发生了变化(有时是你,有时是块)。有些行添加了描述,有些则没有。有一个不完整的句子,标点符号不一致。

阅读这个列表需要更多的工作,因为读者必须重新解析每个项目符号。他们不能假设每个项目符号都包含类似的信息。

注意:这并不意味着每个项目符号都必须非常短,并以动作动词开头!“可预测”并不一定意味着“简单”。它只是意味着每个项目符号应该具有相同的句子结构。此列表也可以:

你能用这个木块做什么?很多东西!

  • 尝试添加引号。有时别人说得最好!
  • 用它来突出你喜欢的链接——共享链接是互联网的通货。
  • 创建一个显示多幅图像的图库,并展示您最好的照片。

在这里,每个项目符号都以一个更加以用户为中心的动词开头,并包含一条补充信息,以获得更多兴趣。标点符号稍有不同,这样可以避免线条过于公式化,但由于每一行的基本结构都是相同的,所以它们仍然易于阅读。

第二:有疑问时,以动词开头。(但不总是同一个动词。)

你必须以动词开头吗?不,但如果你不知所措,你通常不会在动词上出错(尤其是因为项目符号列表经常描述一系列动作或可能的动作)。

在一个纯粹用于指导的简单列表中(例如,在UI副本中,您只需要用户做出决定),可以用相同的动词开始每个项目符号:

要继续,请选择操作:

  • 添加一个简单的文本块。
  • 添加一个左引号块。
  • 添加图像块。

如果你的列表更有说服力(例如,试图通过列出某个功能的优点来说服某人使用该功能)或包含多步骤说明,你会想改变动词以使读者使用更有趣的语言,如上例所示:

你能用这个木块做什么?很多事情!

  • 尝试添加引号。有时别人说得最好!
  • 用它来突出你喜欢的链接——共享链接是互联网的通货。
  • 创建一个可显示多张图像的库,并展示您的最佳照片。

这些并不是硬性规定——例如,你可以选择在说服列表中使用同一个动词,以使其更加集中和有力。但它们是可靠列表的良好起点。

三:当某件事明确是一个列表时,你不必告诉我们它是一个清单。

良好:

你能用这个木块做什么?很多事情!

  • 添加报价。
  • 突出显示你喜欢的链接。
  • 显示多个图像。

不太好:

你能用这个木块做什么?很多事情!下面是一些使用方法的示例。

  • 您可以添加报价。
  • 突出显示你喜欢的链接。
  • 它显示多个图像。很适合画廊!

在尽可能清晰和信任用户之间找到平衡点。一方面,我们知道人们并不总是阅读说明书;另一方面,冗余会让用户觉得我们觉得他们很愚蠢。

勇敢有时是你的朋友。

使用它可以让读者关注项目符号列表中的关键信息。当您的项目符号包含一些补充但最终是次要信息时,这尤其有用。

“关键信息”是,好吧,关键:粗体字吸引眼球,所以要注意给定项目符号中最重要的信息:

你能用这个木块做什么?很多事情!

  • 尝试添加引用有时别人说的最好!
  • 使用它突出显示链接你喜欢分享链接是互联网的货币。
  • 创建一个画廊它可以显示多个图像,并展示您最好的照片。

另一方面,太多粗体字会造成视觉混乱:

你能用这个木块做什么?很多事情!

  • 尝试添加引用有时别人说的最好!
  • 使用它突出显示链接你喜欢分享链接是互联网的货币。
  • 创建一个画廊显示的多个图像展示你的最佳表现照片.

当列表简短且基本时,不要费心折叠,只会增加忙碌感。

你能用这个木块做什么?很多事情!

  • 添加引用.
  • 突出显示链接.
  • 显示多个图像.

语言的缺乏创造了它自己的焦点;你不必再加了。

UI描述

编写单行功能描述或简短描述以澄清选项的指南。

一:最重要的是清晰!

如果用户不明白使用特定选项会导致什么结果,那么无论你的双关语有多聪明都无关紧要。文字游戏和习惯用法经常不清楚,很容易被误解。如果你使用它们,它们应该是补充信息——永远不要解释大意,它们应该是你相当确定的东西,对很多人来说都是可以理解的。

第二:回到第一节,注意那些冗长的短语。

积极的声音通常是更好的方式,当你的空间有限,需要人们能够做出决定和采取行动时,去掉冗长的措辞尤为重要。通常,您可以缩短UI指令短语,使其更简短、更清晰:

单击X时,将发生Y。

与。

单击X执行Y操作。

虽然添加额外的单词有助于引导用户浏览产品,但额外的单词只会模糊所传达的要点:

当您单击“设置”按钮时,弹出窗口将显示可用的高级设置。

与。

单击“设置”访问高级设置。

类似的短语是“Once you do X..”或“If you want to do X…”有时,在一些决策点上,“If you want do X.…”是完全合适的,因为用户可以根据自己的目标选择不同的路径。但是,我们经常用它来表示“这是一件你可以做的事”,你可以更简单地表达为:“做X…”

第三:具体点。

当一个操作取决于用户是否完成了之前的某个操作时,请具体说明需要什么以及接下来会发生什么。我们通常默认为“当你准备好了”
准备好做什么了吗?具体说明前提条件。

“当你准备好了”可以表示:

  • 当您想添加另一个块时“
  • 当你对你的帖子感到满意时”
  • 在你校对完你的文章后”
  • 当您想添加特色图像时“
  • 配置完所有设置后“

当某件事意味着一切时,它实际上意味着什么。说明越具体,就越有用,遵循说明的人对产品越信任。

四:这还在写。它应该有个性和兴趣。

最重要的是,是的,这里的空间通常很有限,但UI文本仍然很有趣。

单行描述仍然可以是完整的句子。

列表。带编号或项目符号。

与。

添加编号或项目符号列表。

你仍然可以使用缩写。

添加列表。我们将提供格式选项。

与。

添加带项目符号的列表-我们将为您提供一些格式选项。

您仍然可以使用标点符号(如破折号、冒号、分号)来控制单词的流动、链接想法和创建停顿。

列表。带编号或项目符号。

与。

添加带编号或项目符号的列表。你的选择!

你仍然可以尽量避免使用行话,而使用通俗易懂的语言。

添加无序或有序列表。

与。

添加编号或项目符号列表。

(因为它可以重复:请不要玩文字游戏!“个性”可以,在UI指令中,应该是微妙的。我们谈论的是听起来像是人说的文字,而不是强迫的奇思妙想。)

五:注意资本化。

对于标题和副标题,有两种大写方式:

在标题情况下,几乎每个单词的第一个字母都大写

在句子大小写中,只有行的第一个字母大写

要素名称和仪表板部分通常使用标题大小写(想想“站点统计”或“最近发布”),而要素标签通常使用句子大小写(如“Show buttons on”或“Comment Likes are”,其中“Likes”是大写的,因为它是要素名称,但整个标签使用的是句子大小写)。

当你查看一整页的UI副本时,确保所有副本都是一致的,并且所有类似的副本标题、工具提示、按钮等都使用相同的情况。

错误消息传递

编写可理解且有用的错误消息的指南。

一:不要忽视错误信息中的语音/音调,因为它们经常沟通。

声音和语调可以说出与单个单词本身一样多的单词。错误消息必须传达大量信息,通常需要相当简短,但不要牺牲语调,也不要朝着消极或积极的方向走得太远。

假设有人试图发布帖子,但他们的用户角色不允许他们这样做。以下是一些我们可以但不应该传达的方式:

您的用户角色不正确。

在这里,我们听起来很冷漠。

停下!您没有权限执行此操作。

在这里,我们听起来不必要的危言耸听和严厉。

Oopsie,我们不能让你那样做!

这里,我们听起来太可爱了。

即使在错误消息中,我们也可以保持直接、积极和友好。怎么用?提示二到四!

第二:尽可能提供解决方案。

一条好的错误消息不仅仅是提醒别人出了问题。

您的用户角色不正确。

好的,很好。为什么这很重要?我该怎么办?这个消息对我有什么帮助?我需要知道为什么我的用户角色很重要,以及如何获得我需要的角色,以便完成我想要完成的操作。不提供任何指令的错误消息会使用户没有前进的路径;如果我们现在不告诉他们,他们就无法避免重复导致错误的行为。

第三:当空间紧张时,不要依靠行话来减少单词。

您的用户角色不正确。请与网站管理员联系。

也许我们正在取得进展:现在我知道我可以做一些事情,这很好。

再说一次,也许我们不是:我仍然不知道我的角色是什么,或者为什么它很重要。此外,现在我不知道网站管理员是什么,我的是谁,或者如何联系他们。

此错误消息中的所有信息在技术上完全正确,但这并不意味着它传达了任何有用的信息。如果我们的目标是理解和解决问题,那么技术准确性并不总是能让我们做到这一点。

“你的帐户没有发布帖子的权限”没有使用用户角色UI的语言,但它确实解释了问题所在,即使我不知道用户角色是什么,我也能理解它。既然我理解了,我也可以更好地理解解决方案,即使消息在这里结束:我可以看到我需要获得许可。

与现有UI语言的一致性很好,但如果它妨碍了理解,则不会。

第四:不要以为人们知道错误的来源。

您的用户角色不正确。

在我们看来,很明显,用户在试图发布某些内容或更改他们没有权限的设置时收到了此消息。这对用户来说可能不太明显:人们经常点击,尤其是当我们不确定如何做某事时,我们并不总是记得我们刚才看的是什么页面或设置(或为什么!)。

好的错误消息还包括一些面向用户的上下文。“您的帐户没有发布帖子的权限”提醒他们,他们正试图发布帖子,而这正是导致错误的特定绊脚石。