# 文案风格指南

这是文书表述上的一些文字格式规范,目的在于增强文字的可读性和保持对外形象的一致性,适用范围包括但不限于软件界面、帮助文档等严肃内容平台,博客和微博等网络宣传媒体平台的用词风格可较轻松活泼些。本指南会不断增补修订。

# 1 标点符号

中文文书原则上请使用全角标点符号,英文文书请使用半角标点符号。中英夹杂原则上请使用全角标点符号。下面有另行规定者例外。

  • 括号的使用:中文文书中,括号中包括数字时采用半角括号,并在括号外留一个空格(连续两个标点符号之间不留空格)。例如:「全部联系人 (12)」。
  • 英文文书逗号和句号后请留一个半角空格;中英夹杂文书中英文 (包括数字) 与汉字之间留一个半角空格。
    • 正确:「这是 1 只 HTC 手机」错误:「这是1只HTC手机」
    • 正确:「2011 年 8 月 14 日」错误:「2011年8月14日」
  • 百分号写法:56.8% 是对的,56.8 % 是错的。百分号和它前面的数字之间不留空格。
  • 段落之间使用 <p> 标签分隔 (一般来说实施效果是,段落间的视觉空隙为一倍 line-height)。段首不要空格。
  • 不要使用「。。。」代替「……」 ,也不要使用三个英文句点「.」代替。
  • 引号一律使用「」,而不是 “”。
  • 严禁出现「!!」。尽量避免使用「!」。请先冷静下来再坐电脑前敲键盘。

# 2 遣词造句

  • 对用户称呼「你」,不再使用「您」。
  • 能用中文就尽量避免英文罗马字。
  • 名词:一些特写的名词可以直接使用原文而不必强译为中文。例如:HTTP、TCP。
  • 用主动语态,不要用被动语态。一般情况下,主动语态比被动语态更有力。
  • 使用具体、明确、展示细节的词汇,能激发想象,使读者自己代入情境。「把硬币放进口袋里,他咧开嘴笑了」,远远强过「他满意地拿走了辛苦挣来的奖赏」。
  • 减少形容词的使用,少用 「的」,避免使用「哈,哈哈」、「呵,呵呵」等。
  • 尽量使用常用词汇,不要用网络新词、科学术语和行话,该解释的要解释清楚。
  • 记住,不要让用户来猜你在写什么。
  • 记住,如果你写了一条文案觉得非常聪明非常好笑,很可能需要停下来想一下用户是否能理解了。(本条感谢 37signals 的文案建议)
  • 「的」「地」「得」要用对。是的,小学都不要求这个了,但是要用对。(「的、地、得」的用法有何区别?- 知乎
  • 卖萌和幽默建议:
    • 以下情况下幽默卖萌需要非常谨慎:报错信息,涉及支付、安全和隐私的信息;
    • 以下情况下推荐卖萌或幽默文案:用户引导、新功能介绍。

# 3 用字规范

  • 根据软件发布流程的一般写法,所有用户可见的版本有:Beta、Release Candidate,未来可能对开发者可见的版本:Alpha。统一为首字母大写。两侧不出现中文或英文引号,也不出现括号。
  • 用 root(小写字母)直接表达 root,不用引号。
  • 「USB 调试」开关
  • 账号(错误:帐号,账户,帐户)
  • 登录账号(错误:登陆)
  • 硬盘空间(不建议使用:磁盘)

# 4 开源软件文案要求

开源、内部开源文档,需要回答如这几个问题:

  • 是什么?能做什么?
  • 为谁服务?
  • 如何使用?
  • 如何为它贡献代码 / 内容?CONTRIBUTING.md
  • 是否有设计 / 架构介绍
文档更新时间: 2020-08-05 12:50:37