中文技术文章排版二三事

关键词：中文、技术文章、排版、博客

0x00. 中文技术文章三要素

文章作者需要从读者的角度考虑自身文章需要注意的要点三：

读者要有东西可读：文章要有厚度
影响度： 60%
有内容可读，即文章要有干货。不要给人来虚的。
此处需要注意：尽量将文章主题明确在一点上，论证/知识体系要相对完整，这样可以保证文章厚度。
读者要读得懂：文章呈现出来的逻辑结构、表述要近人，要易懂
影响度： 20%
比如从读者的角度，调整逻辑结构，添加一些图片说明等等，让读者易懂，能够领会作者的主要意图。
读者要读的舒服：文章 UI，看起来要舒服
影响度： 20%
比如中英文混排、段落空格、标点使用、结构层次、图片大小、图片样式、字体大小、行间距等影响用户阅读体验的内容。

0x02. 要素一：文章厚度

一篇文章一个主题。
文章体系结构尽量完整、论据充足、论证结构合理。
尽量要保证内容的充实。

0x03. 要素二：文章结构

从读者角度看：内容该省则省，该增则增，该调整则调整。

0x04. 要素三：文章 UI

此处主要是文章 UI 角度看，如何让读者读的舒服。不同的人，会有不同的看法。

文章从排版的角度看，第一目的还是在传递信息。当 UI 影响到信息传递，应该让 UI 服从与信息传递这个主要目的。

下文主要从标题、符号、段落、英文、代码几个角度提醒作者注意文章 UI 的细节。

标题
```
#    一级标题：文章的标题
##   二级标题：文章主要部分的大标题
###  三级标题：二级标题下面一级的小标题
#### 四级标题：三级标题下面某一方面的小标题
```
- 标题不跨级，不重复。此处可以参考《金字塔结构》一书。
- 标题要避免孤立编号（即同级标题只有一个）
- 四级标题
  四级标题渲染出来的字体大小，其实跟普通文本差不多，所以不要用，且增加结构复杂度。
  建议做法： 使用加粗文本即可。
- 建议标题最好两级或一级。最后一级用加粗替代
符号
- 空格
  - 中英文间需增加空格
    建议做法： 本文中所有示例都是用 JavaScript 来实现
    不建议做法： 本文中所有示例都是用JavaScript来实现
  - 中文与数字间需增加空格
    建议做法： 理想情况下入参个数应该不多于 2 个。
    不建议做法： 理想情况下入参个数应该不多于2个。
  - 链接之间增加空格
    建议做法： 请提交一个 Issue 并分配给相关同事。
    不建议做法： 请提交一个 Issue并分配给相关同事。
  - 数字和单位之间需要加空格
    建议做法： 一部容量为 16 GB 的智能手机
    不建议做法： 一部容量为 16GB 的智能手机
    例外情况：
    度的标志、百分号不加空格，举例如下：
    今天气温有 35° 的高温。
    据统计，关注 GitHub 的读者中有 80% 是码农。
- 标点符号
  - 中文排版中所有的标点都应该使用中文全角中文标点
    
    全角和半角是英文和中文的编码规范不同遗留下的问题，简单来说，全角占两个字节，半角占一个字节，你可以理解成中文汉字是全角，英文字母是半角，不过半角全角主要是针对标点符号来说的，中文标点占两个字节，英文标点占一个字节。体现在排版上的差异就是，全角字符屏幕打印宽度是两个，而半角字符屏幕打印宽度是一个，如中文逗号和英文逗号他们的显示分别是「，」和「,」。
    TODO: need why
    建议做法： 接下来，我们开始介绍如何将这些技巧应用在具体的开发实践中。
    不建议做法： 接下来, 我们开始介绍如何将这些技巧应用在具体的开发实践中.
  - 遇到英文整句、特殊名词时使用半角标点
    乔布斯说过：「Stay hungry, stay foolish.」
    Facebook, Inc.
  - 省略号占两个汉字空间，包含六个点
    建议做法： 中国设计还有太长路要走……
    不建议做法： 中国设计还有太长路要走…
  - 点号（顿号、逗号、句号等）、结束引号、结束括号等，不能出现在一行的开头
  - 开始引号、开始括号、开始双书名号等，不能出现在一行的结尾
  - 括号内的内容为纯英文和数字或半角英文符号时用半角括号，括号前后加空格
    建议做法： 这些良好的实践适用于任何编程语言，包括最接近硬件 (CTM) 的编程语言
    不建议做法： 这些良好的实践适用于任何编程语言，包括最接近硬件（CTM）的编程语言
  - 全角标点与其他字符之间不加空格
    建议做法： 大家好，我是 leancode，请多多关照。
  - 简体中文使用直角引号
    建议做法： 「老师，『有条不紊』的『紊』是什么意思？」
    不建议做法： “老师，‘有条不紊’的‘紊’是什么意思？”
    此处使用引号的方式，可以参考百度百科关于引号的解释¹：直的引号大多用于竖排，在大陆官方正式用法一般用的是弯引号，但在网络上由于使用竖排美观，故而在简体中文中用的也比较多。
代码格式
代码格式要统一，包括但不限于空格、Tab、分号等用法。
段落
- 首行不空格，采用段落空一行替代
- 合适的行间距
英文
- 英文名词首字母尽量大写
  Google、Android、Facebook。
- 专有名词使用正确的大小写
  GitHub、iOS、iPhone 6S、MacBook Pro。

0x05. 参考资料

排版实例——文章 UI 角度

排版知识介绍——文章 UI 角度

百度百科注释——引号 ↩

中文技术文章排版二三事

中文技术文章排版二三事

0x00. 中文技术文章三要素

0x02. 要素一：文章厚度

0x03. 要素二：文章结构

0x04. 要素三：文章 UI

0x05. 参考资料

排版实例——文章 UI 角度

排版知识介绍——文章 UI 角度

你可能感兴趣的:(排版文章中文格式)