https://github.com/jeasonstudio/doc-guide

guidelines
https://github.com/jeasonstudio/doc-guide

docs guidelines

Last synced: 8 months ago
JSON representation

guidelines

• Host: GitHub
• URL: https://github.com/jeasonstudio/doc-guide
• Owner: jeasonstudio
• License: mit
• Created: 2017-09-07T02:48:26.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-04-10T00:59:59.000Z (over 7 years ago)
• Last Synced: 2025-01-18T03:46:25.868Z (9 months ago)
• Topics: docs, guidelines
• Homepage:
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  
中文博客书写规范



## 0x00 目录

[TOC]

## 0x01 空格

>​ "有研究显示, 打字的时候不喜欢在中文和英文之间加空格的人, 感情路都走得很辛苦, 有七成的比例会在 34 岁的时候跟自己不爱的人结婚, 而其余三成的人最后只能把遗产留给自己的猫. 毕竟爱情跟书写都需要适时地留白. "  

> 与大家共勉之. ——[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)

### 中英文之间需要增加空格

正确:   

> 在 LeanCloud 上, 数据存储是围绕 `AVObject` 进行的. 

错误:   

> 在LeanCloud上, 数据存储是围绕`AVObject`进行的. 

> 在 LeanCloud上, 数据存储是围绕`AVObject` 进行的. 

完整的正确用法:   

> 在 LeanCloud 上, 数据存储是围绕 `AVObject` 进行的. 每个 `AVObject` 都包含了与 JSON 兼容的 key-value 对应的数据. 数据是 schema-free 的, 你不需要在每个 `AVObject` 上提前指定存在哪些键, 只要直接设定对应的 key-value 即可. 

例外: "豆瓣FM" 等产品名词, 按照官方所定义的格式书写. 

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

正确:   

> 今天出去买菜花了 5000 元. 

错误:   

> 今天出去买菜花了 5000元. 

> 今天出去买菜花了5000元. 

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

正确:   

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

错误:   

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

例外: 度／百分比与数字之间不需要增加空格: 

正确:   

> 今天是 233° 的高温. 

> 新 MacBook Pro 有 15% 的 CPU 性能提升. 

错误:   

> 今天是 233 ° 的高温. 

> 新 MacBook Pro 有 15 % 的 CPU 性能提升. 

### 链接之间增加空格

正确:   

> 请 [提交一个 issue]() 并分配给相关同事. 

> 访问我们网站的最新动态, 请 [点击这里]() 进行订阅! 

错误:   

> 请提交一个[issue]()并分配给相关同事. 

> 访问我们网站的最新动态, 请[点击这里]()进行订阅! 

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

正确:   

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

错误:   

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

## 0x02 标点符号

### 不重复使用标点符号

正确:   

> 德国队竟然战胜了巴西队! 

> 她竟然对你说 '喵' ? ! 

错误:   

> 德国队竟然战胜了巴西队! ! 

> 德国队竟然战胜了巴西队! ! ! ! ! ! ! ! 

> 她竟然对你说 '喵' ? ? ! ! 

> 她竟然对你说 '喵' ? ! ? ! ? ? ! ! 

## 0x03 全角和半角

不明白什么是全角 (全形) 与半角 (半形) 符号? 请查看维基百科词条『[全角和半角](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)』. 

### 使用半角中文标点, 并跟随一个空格

正确:   

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

> 核磁共振成像（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》, 非常的有趣. 

## 名词

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

大小写相关用法原属于英文书写范畴, 不属于本 wiki 讨论內容, 在这里只对部分易错用法进行简述.

正确:  

> 使用 GitHub 登录

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

错误:  

> 使用 github 登录

> 使用 GITHUB 登录

> 使用 Github 登录

> 使用 gitHub 登录

> 使用 gｲんĤЦ8 登录

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

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

> 我们的客户有 Github、FourSquare、MicroSoft Corporation、Google、FaceBook, Inc.

> 我们的客户有 gitHub、fourSquare、microSoft Corporation、google、faceBook, Inc.

> 我们的客户有 gｲんĤЦ8、ｷouЯƧquﾑгє、๓เςг๏ร๏Ŧt ς๏гק๏гคtเ๏ภn、900913、ƒ4ᄃëв๏๏к, IПᄃ.

### 不要使用不地道的缩写

正确:  

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

错误:  

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

## 引用

- [掘金翻译计划-译文排版规则指北](https://github.com/xitu/gold-miner/wiki/%E8%AF%91%E6%96%87%E6%8E%92%E7%89%88%E8%A7%84%E5%88%99%E6%8C%87%E5%8C%97)

- [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)

- [Guidelines for Using Capital Letters](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm)

- [Letter case - Wikipedia](http://en.wikipedia.org/wiki/Letter_case)

- [Punctuation - Oxford Dictionaries](http://www.oxforddictionaries.com/words/punctuation)

- [Punctuation - The Purdue OWL](https://owl.english.purdue.edu/owl/section/1/6/)

- [How to Use English Punctuation Corrently - wikiHow](http://www.wikihow.com/Use-English-Punctuation-Correctly)

- [格式 - openSUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)

- [全角和半角 - 维基百科](http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2)

- [引号 - 维基百科](http://zh.wikipedia.org/wiki/%E5%BC%95%E8%99%9F)

- [疑问惊叹号 - 维基百科](http://zh.wikipedia.org/wiki/%E7%96%91%E5%95%8F%E9%A9%9A%E5%98%86%E8%99%9F)