中英文之间添加空格

但注意英文与全角标点符号之间不加空格,如下:

当你凝视着 bug,bug 也在凝视着你

中文与数字之间添加空格

我有 3 台电脑,其中有 1 台平板电脑。

避免长难句

错误:本产品适用于从由一台服务器进行动作控制的单一节点结构
到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
 
正确:本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),
还是由多台服务器(并行处理结构)进行动作控制,均可以使用本产品。

正确使用“的地得”

  • 形容词 + 的 + 名词
  • 形容词(副词)+ 地 + 动词
  • 动词 + 得 + 形容词
那个傻乎乎的男生一看到女神,就傻傻地笑,笑得特别傻。

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

见过最多的错误拼写就是 Github,但它其实是 GitHub。

可以用我偶像 antfu 的 case-police 修改。

不要使用四级及以下标题

如果技术文档出现了四级标题,代表你可能需要删减内容了。

过于复杂的章节并不适合阅读,内容过长时可以用一些简单的 --- 换行符分割。

注意使用顿号

错误:我最欣赏的科技公司有 Google,Facebook,腾讯,阿里和百度等。
 
正确:我最欣赏的科技公司有 Google、Facebook、腾讯、阿里和百度等。

使用全角标点

  1. 中文语句的标点符号,均应该采取全角符号,这样可以与全角文字保持视觉的一致。
  2. 如果整句为英文,则该句使用英文/半角标点。
  3. 句子末尾用括号加注时,句号应在括号之外。
  4. 注意避免“一逗到底”,即整个段落除了结尾,全部停顿都使用逗号。
  5. 补充说明时,使用全角圆括号(),括号前后不加空格。

参考