QuickNote：中文技术文档的写作规范
|
|
hits
本文共811字，阅读完需要约2分钟。
Copyright: 知识共享-版权归属-相同方式共享 3.0 授权协议 | CC BY-SA 3.0 CN
她竟然對你說「喵」？！
QuickNote: 中文技术文档的写作规范
阮一峰和其他贡献者完成的中文技术文档的写作规范仓库。
挑了一些我觉得有一定指导意义的规范。
标题
标题分四级。一级标题是文章的标题，二、三和四级标题分级陈述。
- 不能跨级出现标题。
- 避免同级只有一个标题。
- 下级标题不重复上级标题名字。
- 谨慎使用四级标题。末级标题可以用 Item List 替代。
文本
当时使用等宽字体（如 DOS 、部分文字编辑器等）时，字体也就顺应这种编码形式，将中日韩文字的宽度绘制成拉丁字母和数字的两倍，这样字符的编码存储和显示宽度可以一一对应起来，“单字节”文字显示成“半宽”，“双字节”文字显示成“全宽”。因此当时的用户就开始习惯称中、日、韩等文字为“全角字符”，而称拉丁字母或数字为“半角字符”。
字间距
- 全角中文和半角英文间应有一个半角空格。
- 全角中文和半角阿拉伯数字间半角空格可有可无。半角百分号视同半角阿拉伯数字。
- 半角英文单位和半角阿拉伯数字间适当半角空格。
- 全角标点符号和半角英文或半角阿拉伯数字间不留空格。
句子
- 避免使用长句。多于40字的句子在任何情况下都不能接受。
- 尽量使用简单句和并列句，避免使用复合句。
- 尽量使用肯定句。
- 避免使用双重否定。
风格
- 尽量使用主动语态。
- 用语正式。
- 不用冷僻、生造或文言文词语。
- 的地得：形容词＋的＋名词；副词＋地＋动词；动词＋得＋副词。
- 使用代词时保证只有一个含义。
- 名词前不要加太过多形容词。
英文
- 英文省略号应改为中文省略号。
段落
- 使用陈述语气。
- 段落开头不要留出空白字符。
数值
半角数字
阿拉伯数字一律使用半角。
千分号
- 4位数值，千分号选用。
- 4位以上，应添加千分号。
货币
用阿拉伯数字表示货币数量。在数字前写出货币符号，或在数字后写出货币中文名称。
标点符号
原则
- 中文语句的标点符号，均应该采取全角符号，这样可以与全角文字保持视觉的一致。
- 如果整句为英文，则该句使用英文/半角标点。
句号
句子末尾用括号加注时，句号应在括号之外。
括号
| 英文 | 中文 | |
|---|---|---|
{ } | braces 或 curly brackets | 大括号 |
[ ] | square brackets 或 brackets | 方括号 |
< > | angled brackets | 尖括号 |
( ) | parentheses | 圆括号 |
省略号
省略号占两个汉字空间、包含六个省略点。就像这样：……
破折号
破折号应占两个汉字的位置。如果破折号本身只占一个汉字的位置，那么前后应该留出一个半角空格。