title: "文案撰写指南" post_status: publish comment_status: open taxonomy: category: - gutenberg-docs post_tag: - Contributors - Repos - Data
文案撰写指南
长文本
适用于多行/多步骤说明，或页面/功能叙述性介绍与引导的撰写指南。
具体内容会因情境差异而有较大变化，但以下是一些通用建议：
一：善用缩略形式！
缩略形式更具对话感，是让文本听起来更友好、更随意的简单方法。（还能节省一点空间：一举两得。）
二：删减那些增加字数却无实际意义的短语。
这在两种特定情况下尤为常见。首先，使用被动语态时：
此区块可用于显示单张图片。
每当看到“可用于”或“被用于”这类短语时：请停笔。你正在使用被动语态。尝试改用主动语态，让句子更简洁有力：
此区块显示单张图片。
其次，当我们含糊其辞而非明确陈述时：
画廊区块可帮助您以优雅布局展示多张图片。
它到底能不能？这是我们开发的软件：我们有权利明确说明它的功能和用途：
画廊区块以优雅布局展示多张图片。
我们还经常使用“允许您”这个短语：
预格式化文本允许您保留制表符和换行符。
功能并非“允许”任何人做任何事；它们只是实现特定目标的工具。直接说明其作用即可：
预格式化文本会保留制表符和换行符。
更直接的句子几乎总是更清晰。检查你的文案中是否出现“可以”、“被”、“可能”、“允许您”和“帮助”这些词——它们是最常见的冗余表达，有针对性地查找这些词能帮你定位需要精简的句式。
三：警惕“简单”、“容易”和“只需”。
我们无权决定什么是简单：这应由用户来判断。如果我们声称某事很容易，而用户并未获得轻松的体验，这会削弱他们对我们及我们所构建产品的信任。“只需”一词也是如此——我们许多人知道要避免使用“简单”，却仍频繁使用“只需”。“只需点击这里。”“只需输入用户名。”这本质相同：它暗示某事轻而易举，但我们无法预知用户会认为什么是困难重重。
具体说明往往更稳妥且更有帮助。“容易”和“简单”是我们未详细解释的简略表达；每当看到这些词，不妨花点时间思考它们所替代的具体含义。也许“按‘回车键’即可轻松添加区块”实际意味着“您无需将手离开键盘即可为页面添加更多内容”。太棒了！请直接说明具体内容，而非依赖“容易”这类词汇。
这并非要求您将这些词从词汇表中彻底删除。您可能需要编写提示说明封面图片区块现在需要更少的配置，或发送邮件介绍我们正在构建快速创建自定义区块的工具，此时您完全可以合理地说封面图片区块已简化，或我们正努力让自定义区块创建更容易——在这些情况下，这些术语是描述性且相对的。但请留意您可能正在使用（或过度使用）它们来绝对化地宣称某事容易或简单，并借此机会使表达更具体、更清晰。
四：警惕“我们”的使用
当文本或说明中频繁出现“我们”时，意味着内容的焦点在于软件背后的人，而非软件使用者。有时这确实是你的本意——但通常并非如此。重点通常应放在用户身上：他们的需求以及他们如何受益，而非“我们做了什么”或“我们想要什么”。
只有我们自己才关心我们做了什么或想要什么；用户只想要能正常工作的软件。如果你看到大量“我们”，请思考是否应该重构你的写作，将焦点转向用户的获益与成功。
项目符号列表
（没错）撰写项目符号列表的指南。
第一条：保持所有项目符号的句子结构平行。
平行结构使列表更易于快速阅读——其可预测性减轻了读者的认知负担。
好的示例：
你可以用这个区块做什么？很多事情！
- 添加引用。
- 高亮你喜欢的链接。
- 展示多张图片。
- 创建项目符号列表。
每个项目符号都是一个完整的句子，并以句号结尾。（如果你的列表是一堆一两个词的条目，通常可以合并成一个常规句子——更易读且节省空间。）每行都以一个动词开头，告诉用户这个区块能做什么。句子的主语始终是用户。
用户可以快速理解这个列表，因为一旦他们读完第一项，就明白了如何阅读其余部分，并知道会找到什么信息。
较差的示例：
你可以用这个区块做什么？很多事情！
- 你可以添加引用。
- 高亮你喜欢的链接。
- 它可以展示多张图片。对画廊很有用！
- 项目符号列表
这里，每行的措辞都不同（有些以动词开头，有些以名词开头），句子的主语也在变化（有时是“你”，有时是“区块”）。有些行有附加描述，有些没有。有一个不完整的句子，标点符号也不一致。
阅读这个列表需要更多精力，因为读者必须重新解析每个项目符号。他们无法假设每个项目符号都包含类似的信息。
注意： 这并不意味着每个项目符号都必须非常简短并以动作动词开头！“可预测”不一定意味着“简单”。它只是意味着每个项目符号应该具有相同的句子结构。下面这个列表也是可以的：
你可以用这个区块做什么？很多事情！
- 尝试添加引用。有时别人说得最好！
- 用它来高亮你喜欢的链接——分享链接是互联网的通用货币。
- 创建一个展示多张图片的画廊，展示你最好的照片。
这里，每个项目符号都以一个更以用户为中心的动词开头，并包含一条补充信息以增加趣味性。标点符号略有变化，避免了行文过于公式化，但由于每个项目的基本结构相同，它们仍然易于阅读。
二：犹豫不决时，以动词开头。（但不必总是同一个动词。）
必须用动词开头吗？不一定。但如果你毫无头绪，用动词开头通常不会错（尤其是因为项目列表通常描述一系列动作或可能的动作）。
在纯粹说明性的简单列表中（例如，在只需用户做出决定的界面文案中），每个项目都用同一个动词开头可能没问题：
要继续，请选择一个操作：
- 添加一个简单文本块。
- 添加一个引用块。
- 添加一个图片块。
如果你的列表更具说服力（例如，通过列出功能优势来说服某人使用它）或包含多步骤说明，你应该变换动词，用更生动的语言吸引读者，如上例所示：
这个块能做什么？很多事情！
- 尝试添加一条引用。有时别人的话最精辟！
- 用它来突出你喜欢的链接——分享链接是互联网的硬通货。
- 创建一个展示多张图片的画廊，秀出你的最佳照片。
这些并非铁律——例如，在说服性列表中，你可能会选择使用同一个动词，以更聚焦、更有力。但它们是构建优质列表的良好起点。
三：当内容明显是列表时，无需特意说明
推荐示例：
这个区块能做什么？功能丰富！
- 添加引用。
- 高亮你喜欢的链接。
- 展示多张图片。
欠佳示例：
这个区块能做什么？功能丰富！以下是一些使用方式的示例。
- 你可以添加引用。
- 高亮你喜欢的链接。
- 它可以展示多张图片。很适合做画廊！
在力求清晰与信任用户之间找到平衡。一方面，我们知道用户并不总是阅读说明；另一方面，冗余信息会让用户觉得我们认为他们很笨。
四：粗体有时是你的朋友。
用它来引导读者关注要点列表中的关键信息。当你的要点包含一些补充性但最终次要的信息时，这尤其有用。
“关键信息”是关键所在：粗体吸引眼球，因此应坚持在给定要点中突出最重要的信息：
你可以用这个区块做什么？很多事情！
- 尝试添加引用。有时别人说得最好！
- 用它来突出你喜欢的链接——分享链接是互联网的通用货币。
- 创建一个显示多张图片的画廊，展示你最好的照片。
反之，加粗太多内容会造成视觉混乱：
你可以用这个区块做什么？ 很多事情！
- 尝试添加引用。有时别人说得最好！
- 用它来突出你喜欢的链接——分享链接是互联网的通用货币。
- 创建一个显示多张图片的画廊，并展示你最好的照片。
当列表简短且基础时，不必费心——加粗只会增加杂乱感。
你可以用这个区块做什么？很多事情！
- 添加引用。
- 突出链接。
- 显示多张图片。
文字的缺失本身就形成了焦点；你无需再添加任何强调。
UI 描述
撰写单行功能描述或用于阐明选项的简短描述指南。
第一：清晰至上！
如果用户不理解使用特定选项会产生什么结果，那么你的双关语再巧妙也无济于事。文字游戏和习语常常不清晰，且容易被误解。如果一定要使用，它们应作为补充信息——绝不能用来解释主要概念——并且应确保能被相当广泛的人群理解。
二：回顾第一部分，注意那些冗长的表达方式。
主动语态通常是更好的选择，当空间有限且需要用户能够快速决策和行动时，精简冗长的表达尤为重要。通常你可以将用户界面提示语缩短，使其更简洁明了：
当你点击 X 时，Y 会发生。
对比：
点击 X 以执行 Y。
虽然添加额外词语可能让人觉得是在引导用户使用产品，但这些额外词语反而会模糊要传达的重点：
当你点击“设置”按钮时，弹出窗口将显示可用的高级设置。
对比：
点击“设置”以访问高级设置。
类似的表达还有“一旦你执行 X…”或“如果你想执行 X…”。有时在决策点，“如果你想执行 X…”是完全合适的，因为用户可以根据目标选择不同的路径。但我们经常用它来表示“这是你可以做的事情”，你可以更简单地表达为：“要执行 X…”
三、明确具体
当某个操作需要用户完成前置步骤时，请清晰说明所需条件及后续结果。我们常习惯性使用"当您准备好时"这类表述。
但"准备好"具体指什么？必须明确说明所有前提条件。
"当您准备好时"可能意味着：
- 当您想添加另一个区块时
- 当您对文章内容满意时
- 当您完成文章校对后
- 当您需要添加特色图片时
- 当您配置完所有设置后
若某个表述能指代所有情况，实则毫无意义。指引越具体实用，用户对产品的信任度就越高。
四：这依然是写作。它应具备个性与趣味性。
清晰至上，没错，且此处空间往往有限——但界面文本依然可以读来有趣。
单行描述依然可以是完整的句子。
列表。编号或项目符号。
对比
添加列表，可选择编号或项目符号。
你依然可以使用缩略形式。
添加列表。我们将提供格式选项。
对比
添加项目符号列表——我们会给你一些格式选项。
你依然可以使用标点——破折号、冒号、分号——来控制语句的节奏，连接想法，并创造停顿。
列表。编号或项目符号。
对比
添加列表——编号或项目符号。任你选择！
你依然可以尝试避免术语，使用平实的语言。
添加无序或有序列表。
对比
添加列表，可选择编号或项目符号。
（因为值得重申：请勿使用文字游戏！“个性”可以——在界面说明中，也应该——是微妙的。我们讨论的是听起来像人说的话，而非强求的俏皮。）
五：注意大小写规范
对于标题和副标题，有两种大小写处理方式：
标题式大小写：几乎每个单词的首字母都大写
句子式大小写：仅句首字母大写
功能名称和仪表板分区通常采用标题式大小写（例如“站点统计”或“最近发布”），而功能标签通常采用句子式大小写（例如“显示按钮于”或“评论点赞功能已启用”——其中“点赞”因是功能名称而大写，但整体标签仍遵循句子式大小写）。
当您审视整页界面文案时，请确保所有同类文案（标题、工具提示、按钮等）保持大小写风格的一致性。
错误信息
撰写易于理解且实用的错误信息指南。
一：不要忽视错误信息中的语气/语调——它们传达了大量信息。
语气和语调本身传达的信息可能与具体词汇一样多。错误信息必须传达大量信息，且通常需要相当简短，但尽量不要牺牲语调，也不要走向过于负面或过于积极的方向。
假设某人试图发布帖子，但其用户角色不允许这样做。以下是一些我们可能（但不应）采用的传达方式：
您的用户角色不正确。
这里，我们听起来疏远且漠不关心。
停！您没有执行此操作的权限。
这里，我们听起来不必要地危言耸听且严厉。
哎呀，我们不能让您这样做！
这里，我们听起来过于卖萌。
即使在错误信息中，我们也可以保持直接、积极和友好的态度。如何做到？请看第二到第四条建议！
二、尽可能提供解决方案路径
一条好的错误信息不应仅仅告知用户出现了问题。
您的用户角色不正确。
好吧，但为什么这很重要？我该怎么办？这条信息如何帮助我？我需要知道用户角色的重要性，以及如何获得所需角色来完成我想执行的操作。不提供任何指导的错误信息会让用户无路可走；如果我们不立即告知，他们将无法避免重复导致错误的行为。
三：空间紧张时，不要依赖术语来减少字数。
您的用户角色不正确。请联系站点管理员。
也许我们有所进展：现在我知道可以采取行动了，这很好。
但也许我们仍在原地：我仍然不知道自己的角色是什么，或者它为何重要。而且，我现在不确定站点管理员是什么、我的管理员是谁，或者如何联系他们。
这条错误消息中的所有信息在技术上完全正确，但这并不意味着它传达了任何有用的信息。如果目标是理解和解决问题，技术准确性并不总能让我们达到目的。
“您的账户没有发布文章的权限”没有使用用户角色界面的语言，但它确实解释了问题所在，即使我不知道用户角色是什么也能理解。既然我理解了，我也更有可能理解解决方案，即使消息到此为止：我能看到我需要获得权限。
与现有界面语言保持一致是好事，但不应以牺牲理解为代价。
第四：不要假设用户理解错误来源
您的用户角色不正确。
对我们来说，用户尝试发布内容或更改没有权限的设置时收到此消息可能显而易见。但对用户而言可能并非如此：人们会频繁点击，尤其是在不确定如何操作时，而且我们并不总能记住刚才查看的页面或设置（或原因！）。
好的错误消息还应包含一些引导用户的上下文信息。“您的账户没有发布文章的权限”会提醒用户他们正尝试发布文章，而这正是导致错误的具体障碍。