【实操指南】一分钟学会技术文章的排版

写代码要追求简洁、优美，写中文文章更是如此。

当一篇文章看上去令人赏心悦目，其传播效果也必然事半功倍。

为此，我们综合了一些约定俗成的中文写作规范要求，帮助大家提升对文字排版的认识。学以致用，让你的技术文章看起来更专业、严谨，阅读量节节攀升。

以下为业内通用的排版规范建议，供大家参考。

划重点：给标题分好类

了解标题层级

标题分为四级。

一级标题：文章的标题

二级标题：文章主要部分的大标题

三级标题：二级标题下面一级的小标题

四级标题：三级标题下面某一方面的小标题

使用原则

1、一级标题下，不能直接出现三级标题

示例：下面的文章结构，缺少二级标题。

# 一级标题 ### 三级标题

2、标题要避免孤立编号（即同级标题只有一个）

示例：下面的文章结构，二级标题 A只包含一个三级标题，完全可以省略三级标题 A。

## 二级标题 A ### 三级标题 A ## 二级标题 B

3、下级标题不重复上一级标题的名字

示例：下面的文章结构，二级标题与下属的三级标题同名，建议避免。

## 概述 ### 概述

4、谨慎使用四级标题，尽量避免出现，保持层级的简单，防止出现过于复杂的章节

如果三级标题下有并列性的内容，建议只使用项目列表（Item list）。

示例：下面的结构二要好于结构一。结构一适用的场景，主要是较长篇幅的内容。

结构一 ### 三级标题 #### 四级标题 A #### 四级标题 B #### 四级标题 C 结构二 ### 三级标题 **（1）A** **（2）B** **（3）C**

正文里有中、英文、数字时，这些要注意

需要加空格的

1、中英文之间需要增加空格

正确：

论文已被 NeurIPS 2020 录用，代码已基于 MindSpore 开源首发。

错误：

论文已被NeurIPS 2020录用，代码已基于MindSpore开源首发。

例外：「豆瓣FM」等产品名词，按照官方所定义的格式书写。

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

正确：

今天出去买菜花了 5000 元。

错误：

今天出去买菜花了5000元。

不需要加空格

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

正确：

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

错误：

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

另外，度／百分比与数字之间不需要增加空格：

正确：

今天是 233° 的高温。

新的笔记本有 15% 的 CPU 性能提升。

错误：

今天是 233 ° 的高温。

新的笔记本有 15 % 的 CPU 性能提升。

2、全角标点与其他字符之间不加空格

正确：

有些文献中定义成 reward，那么 reward 的负数就对应此处的损失值。

错误：

有些文献中定义成 reward ，那么 reward 的负数就对应此处的损失值。

标点符号，你用对了吗？

使用原则

1、中文语句的标点符号，均应该采取全角符号，这样可以与全角文字保持视觉的一致。

2、如果整句为英文，则该句使用英文/半角标点。

3、句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。

4、点号（句号、逗号、顿号、分号、冒号）不得出现在标题的末尾，而标号（引号、括号、破折号、省略号、书名号、着重号、间隔号、叹号、问号）可以。

5、不重复使用相同的标点符号来显示强调突出，比如多个感叹号连用。

省略号

1、省略号占两个汉字空间、包含六个省略点，不要使用。。。或...等非标准形式。

正确：

中国设计还有太长路要走……

错误：

中国设计还有太长路要走…

2、省略号不应与“等”这个词一起使用。

正确：

我们为会餐准备了各色水果，有香蕉、苹果、梨……

我们为会餐准备了香蕉、苹果、梨等各色水果。

错误：

我们为会餐准备了香蕉、苹果、梨…等各色水果。

破折号

1、破折号————一般用于进一步解释。

2、破折号应占两个汉字的位置。如果破折号本身只占一个汉字的位置，那么前后应该留出一个半角空格。

例句：直觉 —— 尽管它并不总是可靠的 —— 告诉我，这事可能出了些问题。

连接号

1、连接号用于连接两个类似的词。

2、以下场合应该使用直线连接号（-），占一个半角字符的位置。

两个名词的复合

图表编号

例句：氧化-还原反应

例句：图 1-1

3、数值范围（例如日期、时间或数字）应该使用波浪连接号（～），占一个全角字符的位置。

例句：2009 年～2011 年

注意，波浪连接号前后两个值都应该加上单位。

4、波浪连接号也可以用汉字“至”代替。

例句：周围温度：-20°C 至 -10°C

顿号

1、句子内部的并列词，应该用全角顿号(、) 分隔，而不用逗号，即使并列词是英语也是如此。

正确：

我最欣赏的科技公司有 Google、Facebook、苹果、华为等。

错误：

我最欣赏的科技公司有 Google, Facebook, 苹果, 华为等。

2、英文句子中，并列词语之间使用半角逗号（,）分隔。

例句：Microsoft Office includes Word, Excel, PowerPoint, Outlook and other components.

全角和半角

关于全角（全形）与半角（半形）符号的区别，可以查看维基百科词条『全角和半角』。

使用全角中文标点

正确：

嗨！你知道嘛？今天前台的小妹跟我说「喵」了哎！

核磁共振成像（NMRI）是什么原理都不知道？JFGI！

错误：

嗨! 你知道嘛? 今天前台的小妹跟我说 “喵” 了哎!

嗨!你知道嘛?今天前台的小妹跟我说”喵”了哎!

核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!

核磁共振成像(NMRI)是什么原理都不知道?JFGI!

数字使用半角字符

正确：

这件蛋糕只卖 1000 元。

错误：

这件蛋糕只卖 １０００ 元。

遇到完整的英文整句、特殊名词，其內容使用半角标点

正确：

乔布斯那句话是怎么说的？「Stay hungry, stay foolish.」

推荐你阅读《Hackers & Painters: Big Ideas from the Computer Age》，非常的有趣。

错误：

乔布斯那句话是怎么说的？「Stay hungry，stay foolish。」

推荐你阅读《Hackers＆Painters：Big Ideas from the Computer Age》，非常的有趣。

专有名词，写的地道些

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

无论是否在句首都应该以同样的方式写。

正确：

使用 GitHub 登录

我们的客户有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。

错误：

使用 github 登录

使用 GITHUB 登录

我们的客户有 github、foursquare、microsoft corporation、google、facebook, inc.。

我们的客户有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK, INC.。

不要使用不地道的缩写

正确：

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

错误：

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

引用内容，切记标明出处

本文转载自华为云社区

文中有使用外站图片，必须在文末标明。来源如果来自外站必须添加链接，来源如果来自外部作品则不需要。如：

本文部分图片来自华为云

本文部分内容编译自 GitHub

本文部分观点来自华为云

本文参考链接

中文技术文档的写作规范

写作规范和格式规范

https://open.leancloud.cn/copywriting-style-guide/

AI

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。