中文技术文档写作规范
标点符号
1). 只有中文或中英文混排中,一律使用中文/全角标点。
2). 中英文混排中如果出现整句英文,则在这句英文中使用英文/半角标点。
3). 中文标点与其他字符间一律不加空格。
正确:有:Apple、Android、诺基亚
错误:有:Apple 、 Android 、 Nokia
4). 句子末尾用括号加注时,句号应在括号之外。但当括号中的内容为独立的语句时,句号应被包含在括号内
错误:关于文件的输出,请参照第 1.3 节(见第 26 页。)
正确:关于文件的输出,请参照第 1.3 节(见第 26 页)。
正确:鲍勃在他的女朋友生日当天买了一束花作为生日礼物。(他之前从没这样做过。)
5). 中文文案中引用时,应该使用全角双引号(“ ”)。引号里面还要用引号时,外面一层用双引号,里面一层用单引号(‘ ’)。
例句:许多人都认为客户服务的核心是“友好”和“专业”。
例句:鲍勃解释道:“我要放音乐,可萨利说,‘不行!’。”
6). 省略号请使用……标准用法,不要使用。。。 ,也不要使用三个英文句点.。
错误:我们为会餐准备了香蕉、苹果、梨…等各色水果。
正确:我们为会餐准备了各色水果,有香蕉、苹果、梨⋯⋯
正确:我们为会餐准备了香蕉、苹果、梨等各色水果。
7). 感叹号:请勿使用!!。尽量避免使用!。请先冷静下来再坐电脑前敲键盘。
文字,数字与空格
1). 英文与非标点的中文之间需要有一个空格。
正确:使用 DaoCloud 自动构建和部署。
错误:使用DaoCloud自动构建和部署。
2). 数字与非标点的中文之间需要有一个空格。
正确:这是 1 款 Android 应用
错误:这是1款Android应用
正确:2014 年 2 月 14 日
错误:2014年2月14日
3). 尽可能使用中文数词,特别是当前后都是中文时。如:我们发布了五个产品。
4). 英文单位若不翻译,则单位前的阿拉伯数字与单位间不留空格。
正确:一部容量为 16GB 的智能手机的价格大约是人民币 3000 元
错误:一部容量为 16 GB 的智能手机的价格大约是人民币 3000 元
5). 书写时括号中全为数字,则括号用半角括号且首括号前要空一格,例如联系人 (22)。
6). 半角英文字符和半角阿拉伯数字,与全角标点符号之间不留空格。
错误:他的电脑是 MacBook Air 。
正确:他的电脑是 MacBook Air。
7). 阿拉伯数字一律使用半角形式,不得使用全角形式。
错误:这件商品的价格是1000元。
正确:这件商品的价格是 1000 元。
8). 数值为千位以上,应添加千分号(半角逗号)。
XXX 公司的实收资本为 ¥1,258,000 人民币。
对于 4 位的数值,千分号是选用的,比如1000和1,000都可以接受。对于 4 位以上的数值,应添加千分号。
9). 货币应为阿拉伯数字,并在数字前写出货币符号,或在数字后写出货币中文名称。
$1,000
1,000 美元
英文的货币名称,建议参考国际标准 ISO 4217。
10). 英文原文如果使用了复数形式,翻译成中文时,应该将其还原为单数形式。
英文:...information stored in random access memory (RAMs)...
中文:⋯⋯存储在随机存取存储器(RAM)里的信息⋯⋯
11). 外文缩写可以使用半角圆点(.)表示缩写。
U.S.A.
Apple, Inc.
12). 专有名词使用正确的大小写:Android、iOS、iPhone、Google、Apple,无论是否在句首都应该以同样的方式写。
13). 在官方文案中尽量使用中文,避免中英文混合的情况。例如App一般应写为应用或移动应用。品牌、产品名、人名、地名等特殊名词,如果来自英文,请使用英文以避免在不同译法之间选择。
段落
1). 如果是纯文本,段落之间使用一个空行隔开。如果是 HTML 或其他富文本格式,使用额外空白作为段落间的分隔。
2). 段落开头不要留出空白字符。
3). 引用第三方内容时,应注明出处。
One man’s constant is another man’s variable. — Alan Perlis
4). 如果是全篇转载,请在全文开头显著位置注明作者和出处,并链接至原文。
本文转载自 WikiQuote
5). 使用外部图片时,必须在图片下方或文末标明来源。
本文部分图片来自 Wikipedia
6). 若文章为全文翻译,必须在注明作者和出处,并链接至原文。
7). 若文章为部分编译,则需在文末注明作者和出处。如:本文部分内容编译自 Apple 本文部分观点来自煮机网微博。
参考
写作规范和格式规范, by DaoCloud
简体中文规范指南, by lengoo
中文技术文档的写作规范, by 阮一峰
- 版权声明: