跳到主要内容

文章格式规范

这篇文章将介绍 VisonKB 文章的格式规范。

如果你想了解如何提交文章,请阅读 文章编写指南

1. 空格的使用

1.1 中文和英文

中英文之间需要增加空格

正确:

在 RoboMaster 全国大学生机器人大赛比拼的是参赛选手们的能力、坚持和态度。

错误:

在RoboMaster全国大学生机器人大赛比拼的是参赛选手们的能力、坚持和态度。
在 RoboMaster全国大学生机器人大赛比拼的是参赛选手们的能力、坚持和态度。

1.2 中文和数字

中文与数字之间需要增加空格

正确:

今天出去买菜花了 5000 元。

错误:

今天出去买菜花了 5000元。
今天出去买菜花了5000元。

1.3 数字和单位

数字与单位之间无需增加空格

正确:

我家的光纤入户宽带有 10Gbps,SSD 一共有 10TB。

错误:

我家的光纤入户宽带有 10 Gbps,SSD 一共有 20 TB。

Tips: 另外,度/百分比与数字之间不需要增加空格: 正确:

今天是 233° 的高温。
新 MacBook Pro 有 15% 的 CPU 性能提升。

错误:

今天是 233 ° 的高温。
新 MacBook Pro 有 15 % 的 CPU 性能提升。

1.4 半角标点

半角标点之后需要增加空格

正确:

I think, therefore i am.

错误:

I think,therefore i am.

tips: 全角标点与其他字符之间不增加空格 正确:

刚刚买了一部 iPhone,好开心!

错误:

刚刚买了一部 iPhone ,好开心!

2. 标点符号和数字的使用

2.1 不重复使用

正确:

德国队竟然战胜了巴西队!
她竟然对你说「喵」?!

错误:

德国队竟然战胜了巴西队!!!
她竟然对你说「喵」???!!!
她竟然对你说「喵」?!?!??!!

2.2 全角半角标点

个人观点是英文整句和句子含有数字使用半角标点,中文句子使用全角标点(包含英文单词)。
半角标点就是输入法在英文状态下输入的标点,全角即是中文。 正确:

这件蛋糕只卖 1000 元。
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
乔布斯那句话是怎么说的?「Stay hungry, stay foolish.」
推荐你阅读《Hackers & Painters: Big Ideas from the Computer Age》,非常的有趣。

错误:

这件蛋糕只卖 1000 元。
核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!
乔布斯那句话是怎么说的?「Stay hungry,stay foolish。」
推荐你阅读《Hackers&Painters:Big Ideas from the Computer Age》,非常的有趣。

2.3 半角全角混合

使用全角半角混合,让标点只占一格

正确:

奶奶总说:“我喜欢暴跳如雷.”
(QAQ)(QWQ)

错误:

奶奶总说:“我喜欢暴跳如雷。”
(QAQ)(QWQ)

2.4 阿拉伯数字

阿拉伯数字一律使用半角形式,数值为千位以上,应添加千分号(半角逗号)。

正确:

这件商品的价格是 1000 元。
XXX 公司的实收资本为 ¥1,258,000 人民币。

错误:

这件商品的价格是 1000 元。
XXX 公司的实收资本为 ¥1,258,000 人民币。

2.5 表示数值范围

表示数值范围时,用波浪线“”连接

正确:

132 kg~234 kg
67%~89%

错误:

132 kg - 234 kg
67% - 89%

2.6 数字的增减

数字的增加要使用“增加了”、“增加到”。“了”表示增量,“到”表示定量。

数字的减少要使用“降低了”、“降低到”。“了”表示增量,“到”表示定量。

样例:

增加到过去的两倍
(过去为一,现在为二)

增加了两倍
(过去为一,现在为三)

**Tips:**不能用“降低 N 倍”或“减少 N 倍”的表示法,要用“降低百分之几”或“减少百分之几”。因为减少(或降低)一倍表示数值原来为一百,现在等于零。

全角与半角的区别详情见 全角标点和半角标点


3. 名词的使用

3.1 专有名词

专有名词使用正确的大小写

正确:

使用 GitHub 登录

错误:

使用 github 登录
使用 GITHUB 登录
使用 Github 登录

3.2 地道的缩写

不要使用不地道的缩写

我们需要一位熟悉 JavaScript、HTML5,至少理解一种框架(如 Backbone.js、AngularJS、React 等)的前端开发者。

错误:

我们需要一位熟悉 Js、h5,至少理解一种框架(如 backbone、angular、RJS 等)的 FED。

4. 标题的使用

4.1 不使用过多标题

超过四级的标题很容易导致目录或者文章结构的混乱

4.2 不使用跳级标题

不能在使用一级标题后直接使用三级标题

4.3 同级标题不重名

使用多级标题且子标题较多时应该使用1.x 1.1.x等区分子标题


5. 文本注意事项

5.1 使用简单句

避免使用长句,多使用简单句,在长句无法避免的情况下使用符号断开来形成短句

正确:

本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),还是由多台服务器(并行处理结构)进行动作控制,均可以使用本产品。
他昨天生病了,没有参加会议。
请确认装置的电源已关闭。
用户必须拥有删除权限,才能删除此文件。

错误:

本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
那个昨天生病的人没有参加会议。
请确认没有接通装置的电源。
没有删除权限的用户,不能删除此文件。

5.2 文件名称

不使用中文名称作为文件名,且英文应使用 ” _ “ ,而不是空格或者 “ - ” 连接标题

正确:

advanced_usage.md
glossary.md

错误:

advanced-usage.md
名词解释.md

5.3 说明文件

为了醒目某些说明文件,可以使用全大写字母,比如READMELICENSE


6. 其他排版细则

6.1 链接网址

链接网址不要直接甩个链接,前面要有说明

正确:

参考链接:中文技术文档书写指东 - 少数派 (sspai.com)
对于详细的规则,可以参考[《xxx规则指南》](https://github.com/mzlogin/chinese-copywriting-guidelines)

错误:

参考链接:https://sspai.com/post/68349
对于详细的规则,可以参考:https://github.com/mzlogin/chinese-copywriting-guidelines

本文参考:

  1. 中文文案排版指北

  2. 调整标点,快速拯救你的排版

  3. 中文技术文档书写指东 - 少数派 (sspai.com)

  4. Wikiquote

  5. GitHub - ruanyf/document-style-guide: 中文技术文档的写作规范