中文文档格式规范
原文:中文文档格式规范
格式规范的目的是为了提供一些准则、方针,使得文档的风格一致。
以下的规则并没有声明不能变动,也不暗示這些规则比其他方式都要好,但如果所有人的编辑方式都一致,我们的文档会更易于阅读和使用,并让撰写和编辑变得更加方便。
中英文混合
在科技行业,英文的专有名词或者通俗缩写非常多,因此文档内中英文混合排版不可避免。
选择明确、简洁的词汇
在选择使用中文还是英文时,我们以最能明确、简洁地表达意图为原则。例如在没有被广泛接受之前,NBA 不要写成“北美职业篮球联赛”。
专有名词使用正确的大小写
正确:
使用 GitHub 登录
错误:
使用 Github 登录
使用 github 登录
空格
中英文之间需要增加空格
正确:
本站点使用 Jekyll 搭建,应用 HPSTR 主题。文章保存在
_posts
目录下。
错误:
本站点使用Jekyll搭建,应用HPSTR主题。文章保存在
_posts
目录下。
完整的正确用法:
请尽量避免直接使用系统自带的 Ruby,推荐使用 rbenv 来管理本地 Ruby 运行环境,同时使用 ruby-build 来安装 Ruby,现使用的 Ruby 版本为 2.1.1。
中文与数字之间需要增加空格
正确:
今天出去买菜花了 5000 元
错误:
今天出去买菜花了 5000元
今天出去买菜花了5000元
数字与单位之间需要增加空格
正确:
我家的带宽有 1 Gbps,硬盘一共有 10 TB。
错误:
我家的带宽有 1Gbps,硬盘一共有 10TB。
标点符号
中文排版时,一律使用全角(fullwidth)中文标点
正确:
嗨!你知道吗?今天前台的小妹跟我说“喵”了哎!
错误:
嗨!你知道吗?今天前台的小妹跟我说”喵”了哎!
嗨!你知道吗?今天前台的小妹跟我说”喵”了哎!
中英排版时,一律使用全角(fullwidth)中文标点
正确:
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
错误:
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
中英排版时,遇到完整的英文整句,整句内容使用半角(halfwidth)中文标点
正确:
乔帮主那句话怎么说的?“Stay hungry, stay foolish.”
错误:
乔帮主那句话怎么说的?“Stay hungry,stay foolish。”
其他
中文链接增加空格
建议用法:
访问我们网站的最新动态,请 点击这里 进行订阅。
对比用法:
访问我们网站的最新动态,请点击这里进行订阅。
简体中文与正体(繁体)中文
建议使用简体中文。
地区词汇
建议使用中国大陆通用的词汇,例如使用“程序”,避免使用“程式”。