触动文案写作风格指南

入职培训

目录

标点符号

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

括号的使用

中文文书中，括号中全部为数字时采用半角括号，并在括号外留一个空格。例如：

「全部联系人 (12)」。

英文文书逗号和句号后请留一个半角空格;中英夹杂文书中英文 (包括数字) 与汉字之间留一个半角空格。

正确：「2016 年 7 月 13 日」
错误：「2016年7月13日」

正确：「触动精灵 2.3.6」
错误：「触动精灵2.3.6」

百分号写法

56.8% 是对的，56.8 % 是错的。百分号和它前面的数字之间不留空格。

段落之间

使用标签分隔 (一般来说实施效果是，段落间的视觉空隙为一倍 line-height)。段首不要空格。

省略号

不要使用「。。。」代替「……」 ，也不要使用三个英文句点「.」代替(实施：两个 … )。

引号

一律使用「」，而不是 “ ”。

感叹号

严禁出现「!!」。尽量避免使用「!」。请先冷静下来再坐电脑前敲键盘。

长数字的书写

从小数点起，向左和向右每三位数字一组，组间空格。示例：2 748 456。

遣词造句

对用户称呼「您」。

人称代词

当提及触动或帮你玩团队时，请尽量使用「触动」「帮你玩」代替「我们工程师团队」、「我们」。

数字

能用中文就尽量避免英文罗马字。

手机品牌

中国的用中文，外国的用英文。

手机系统

尽量使用「iOS」「Android」代替苹果系统、安卓系统（在QQ群和用户交流时则根据用户习惯使用）。
注意字母大小写。

语态

用主动语态，不要用被动语态。一般情况下，主动语态比被动语态更有力。

使用具体、明确、展示细节的词汇，能激发想象，使读者自己代入情境。「把硬币放进口袋里，他咧开嘴笑了」，远远强过「他满意地拿走了辛苦挣来的奖赏」。

避免使用反问句，如：难道不是你自己安装有问题吗？

形容词

减少形容词的使用，少用 「的」，避免使用「哈，哈哈」、「呵，呵呵」等。

网络词汇

请使用常用词汇，不要用网络新词、科学术语和行话，该解释的要解释清楚。例如，「任务」等词即过于技术化，APK 亦禁止出现。

记住，不要让用户来猜你在写什么。

记住，如果你写了一条文案觉得非常聪明非常好笑，很可能需要停下来想一下用户是否能理解。

「的」「地」「得」

「的」「地」「得」要用对。是的，连小学都不要求了但是要用对。

卖萌和幽默建议

以下情况下幽默卖萌需要非常谨慎：报错信息，涉及支付、安全和隐私的信息;

以下情况下推荐卖萌或幽默文案：用户引导、新功能介绍。

用字规范

手机正式名称可以以 Apple 官网和 Google Phone Gallery 上的为准，括号加注通用名或昵称，如：「the New iPad (iPad3)」「Google Nexus One (N1 或 G5)」，「HTC Desire (G7)」。禁止只用通用名的写法。

其中 iOS 设备在获取信息时在后台显示的可能是用 iPhone7,3 来表示 iPhone6 的某个型号，需要在展示中根据机型对照表显示为常用名称。

根据软件发布流程的一般写法，所有用户可见的版本有：Beta、Release Candidate，未来可能对开发者可见的版本：Alpha。
统一为首字母大写。
两侧不出现中文或英文引号，也不出现括号。

用 root(小写字母)直接表达 root，不用引号。

触动精灵官方函数统一为首字母小写，之后的单词首字母大写，如：touchDown、showUI、findMultiColorinRegion,注意介词一直都是小写。

产品名

触动有多个产品，即「触动精灵」「触动精灵」「帮你玩」「触动精灵企业版」「触动小精灵」。
其中「触动精灵企业版」分为「手机客户端」、「中控」「云控」三部分，在与用户沟通时请明确表达。
一般情况下使用「普通版」和「企业版」来区分「触动精灵」和「触动精灵企业版」。

如有可能出现混淆，用通俗易懂的语言告知用户。如：「请在手机上打开触动精灵企业版客户端」，或使用「电脑上的企业版中控端」、「手机上的触动精灵」。

开发者平台

触动有四个开发者平台：「触动精灵」「帮你玩脚本商城」「触动精灵企业版」「触动小精灵」。

更新日志

按照新增、优化、修复的顺序对更新日志内容进行排序。

小精灵、帮你玩、企业版将引擎版本放在第一行。

新增 xxx 功能/函数
优化 xxx 界面/功能/函数
修复 xxx 问题

常用名词列表

Android(错误：android、安卓)(补充：SEO 或 QQ、旺旺情况下可以使用安卓)

iOS(错误：ios、苹果)(补充：SEO 或 QQ、旺旺情况下可以使用苹果)

iPhone(错误：iphone、苹果手机)(补充：SEO 或 QQ、旺旺情况下可以使用苹果手机)

iPad(错误：ipad、平板电脑)(补充：SEO 或 QQ、旺旺情况下可以使用平板电脑)

Wi-Fi(错误：WiFi、Wifi、Wi-fi)

email (错误：E-mail、Email)

短信(错误：短信息)

通讯录(指 Contacts 功能时，不应称为联系人)

「USB 调试」开关

账号(错误：帐号，账户，帐户)

登录账号(错误：登陆)

硬盘空间(不建议使用：磁盘)

明确区分「脚本」和「外挂」，前者仅为使用函数进行找色点击等操作，依赖触动精灵客户端运行的代码；后者为涉嫌修改目标应用程序文件和数据的违规操作。

不使用「温馨提示」一词

文案规范

文案完成后，请先自己检查无误后，与相关人员讨论确认，达成一致意见的最终版再传达给设计或技术，避免由于文案或需求变更增加对方工作量。

作业部落 Markdown 格式

在使用作业部落之前请先阅读官方说明文档：
欢迎使用 Cmd - 在线 Markdown 编辑阅读器
Cmd Markdown 简明语法手册
Cmd Markdown 高阶语法手册

作业部落使用左右对照格式，左边为编辑框，右侧为预览效果。

编辑

• 在文档右上角点击笔状按钮进入编辑状态。
• 在发布更新右侧的按钮点击选择要进行编辑的文档。

标题

• 标题默认为 H1 格式，不要再加#。
• 除标题外，不要在正文内容中再次使用 H1，而是从 H2开始。
• 文档标题尽量使用概括性词语，如「帮你玩脚本商城使用手册」，而不是「帮你玩使用和安装」。

分类

• 如非必要，尽量使用已创建的分类，每个文档按照文档类型、产品类型、产品细分填写分类。
• 文档分类包含：文档类型（开发手册、使用手册、教程示例）、产品类型（触动精灵、帮你玩、小精灵、企业版）、产品细分（开发者平台、API）

目录

• 在标题下方添加 [TOC] 和空行即可在正文上方添加目录。
• 目录会显示所有层级的标题，即加了#号的内容，所以标题应选择尽量简短的词语或语句而不是很长的句子。

正文

• 内容尽量按照用户使用流程进行介绍，如有可能尽量配合图片，避免使用大量的文字。
• 如果文字较多时，请考虑是否能够使用列表或表格更加清晰地进行介绍。

图片

• 触动官方作业部落账号为高级会员，可以使用图片插入功能，尽量避免使用外链。
• 高级账号还支持直接将复制的图片粘贴到文档内，需要注意的是要等待图片上传完成显示再进行其他操作，否则会插入图片失败。
• 配图尽量使用印象笔记圈点进行批注，并在连续插入图片时在下方插入斜体文字进行简短介绍。
• 作业部落支持 <center> </center>标签，对于一些较大的图片和下方说明文字可使用此标签进行居中显示。
  

引用

• 对于一些想要突出显示的内容，可以使用引用格式。
• 需要注意的是，引用格式需要多打空行来避免对下面输入的内容干扰。
• 使用 > 表示文字引用。

示例：

野火烧不尽，春风吹又生。

代码

• 在开发文档类目下的文档需要经常插入代码，请参考之前输入的内容查看如何使用代码格式。
• 使用 `代码` 表示行内代码块。

实际显示效果

local index = 1
while true do
    mSleep(1000)
    toast("安卓两只小蜜蜂，嗡嗡嗡~"..index)
    index = index + 1
    mSleep(5000)
    nLog(index)
end

表格

在使用表格功能时，尽量在之前的文档中复制粘贴格式然后填充内容，避免出错。

开发文档

请注意之前使用的格式和内容，添加新函数时需要输入的内容：

• 函数：英文名和中文名
• 函数名称：中文名
• 函数功能：简短介绍
• 支持版本：版本号前面需要加 v
• 函数方法：无冒号、不适用代码格式、写明返回值，用表格列出参数、类型并给出说明
• 脚本示例：代码格式，注意次数输入的代码需要现在编辑器中 CTRL + i 自动修正缩进。
• 注意事项：引用格式、列表格式，需要突出显示的词语使用英文输入状态下数字 1 左边的按键加背景色。

保存和发布

• 作业部落有自动保存功能，可随时发布查看效果。
• 如果是不适合公开的文档，可在发布时添加密码。