我的中文写作指北

专有英语名词

TOP ⬆

我的中文写作指北

分享总结一篇对我来说很受用的文章「中文技术文档书写指东」

背景介绍

「给程序员的中文写作指北」 整体分为三大结构，即内容、排版和行文。内容和行文是需要持续练习的，各位可以将「指北」作为起点，并在生活中加以练习，下面就不再赘述了，这篇总结以分析排版为主。

内容：…
排版：一篇文章/文档的门面，也是一条无形准线，写好文章的第一步就是守好准线。
行文：…

专有英语名词

英语中的专有名词的大小写区分上是很有讲究的，通常是以首字母大写，有时会再使用一些适当的缩写，例如 ViMo 就是 Vision Inspection and MORE 的缩写，所以 Vimo vimo VIMO 的写法其实是不规范的。

ViMo ✅
vimo ❌

在日常生活中，于此相似的常见单词还有：✅

JavaScript / JS / js
NodeJS / Node.js
HTTP / http
VSCode / vscode
Vue.js
Vite

以下写法都是不规范的：❌

Javascript
Node / NodeJs
Http
VsCode
Vue
vite / vite.js

换行/空格

章节换行
保持全文的换行格式相同，如不同章节的结尾使用换行的行数应该是一致的，可以用一个换行来与下一个章节形成区分；
段落缩进
内容上有关系的段落应该保持相同的缩进，以帮助读者更清晰地区分文章结构；缩进时最好不好使用空格，而是制表符，或者使用文本编辑器提供的「缩进」功能；
英文空格
在中英文混合输入的时候，记得务必「留好空格」。英文语句的前后都要加一个空格，在英文标点符号也需要添加一个空格，这样能帮助读者阅读起来流畅，太拥挤的文字阅读体验是不佳的。
- 生存還是毁滅，這是一個值得思考的問題。To be or not to be, that’s a question. 《哈姆雷特》
- 生存還是毁滅,這是一個值得思考的問題.To be or not to be,that’s a question.《哈姆雷特》

高亮加粗

粗体（如无必要，勿用粗体）
增强对比度的方式有多种，例如「」、《》往往就要比加粗更好用，粗体适合于用在标题、段落开头形成的段落感，如果用粗体来突出文章内容，往往会适得其反，让原本流畅的阅读体验变得突兀。
增强对比度 的方式有多种，例如「」、《》往往就要比加粗更好用，粗体适合于用在标题、段落开头形成的段落感，如果用粗体来突出文章内容，往往会适得其反，让原本流畅的阅读体验变得突兀。（例如当你阅读这一个段落的时候，你会发现自己翻来覆去地多阅读了几遍）
着色高亮
当你需要把语句、段落突出时，使用高亮是合理的，但即使是高亮，也要注意挑选一些柔和的颜色，特别是在「夜间阅读」的模式下，如果文章中使用了一个荧光绿，那对读者的眼睛和心理留下的创伤可能会蛮严重的。
不必要的情况
解释说明用斜体、下划线即可，不需要重点阅读的文字应该更加隐形，而不是为了和正文形成对比而变得瞩目，加粗高亮明显不适用。

引用/链接

引述他人

“ 别人说的话，需要用「引用」告知，这是一种互相尊重 ” - 沃之几索得
警告、提示

免责声明：「引用」被用来做副标题、告知、通知也是很常见的
链接
- 在线的文档应当直接提供文字超链接，使用 URL 容易导致文档内容格式混乱，也不方便用户的使用，造成不必要的成本；
- 简历、书信等各类有纸质打印需求的场景，则在提供文字超链接的同时，还应当留有脚注或者二维码，否则读者容易一头雾水；
- 最好是方式是在文章末尾列出所有引用的地址和标题，在文档中统一使用超链接和标注。

其他

标点符号

中文统一使用全角符号，英文用半角符号，二者不能任意的混用；
不推荐中文使用半角符号并利用空格分隔；
「」引号：用来引用參照內容。

文本对齐

不要随意使用「居中」，这是比较常见的格式错误，在我们生活的各个地方都存在了太多居中，居中像是一种 “常规” 方案，但实际上居中是会影响文本阅读的体验的，推荐让文章就呈现出文章该有的样子，就如同你在正式地书面书写时，也不会突然把内容位置安排到中间去。
「两端对齐」是种好方案，需要使用这类对齐方式的文章，内容通常是混合了中英文的，最好是在书写完成后重新排版时再使用这种方案进行调整，当然，也可以是每完成一个「段落」就进行调整。

保证一致性
文章使用的格式必须是统一的，例如字体、换行方式、缩进方式、标点符号… 否则「排版」就无从谈起。

总结

以上，就是我对《给程序员的中文写作指北》的「排版」部分延伸，推荐大家从现在开始就保持好一个良好的书写习惯，从排版开始，可以为内容和行文搭出好的框架，守住文章的 “底线” 。