# guide

**Repository Path**: qyvlik/guide

## Basic Information

- **Project Name**: guide
- **Description**: 开发规范导向
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2015-09-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目规范导向

这里是项目规范导向，主要讲解文档编写规范。

## 空格

- 中英文之间需要有空格，例如：Apple Watch 将于下周开始接受预订。
- 中文与数字之间需要有空格，例如：下午跑步 1 小时。
- 数字与单位之间需要有一个空格，例如：是「5 GB」而不是「5GB」。
- 全角标点符号与其他之间不需要空格。
- 英文单词左或者右是标点符号的时候，不需要空格。

## 标点符号

- 只有中文或中英文混排中，一律使用中文/全角标点。
- 中英文混排中如果出现整句英文，则在这句英文中使用英文/半角标点。
- 中文标点与其他字符间一律不加空格。
- 尽量避免重复使用标点（尤其是叠加感叹号、问号等），例如「！！！」；

## 英文单词大小写

- 所有的专业词汇必须和对应官网一样，详见 [常用专业词汇](https://raw.githubusercontent.com/qyvlik/guide/master/glossary.md)

## 段落

- 段落开头不要留出空白字符，顶格写。
- 段落之间使用一个空行隔开。

## 文件命名

- 文件夹：英文小写（多个英文减号连接）；  
正确：copywriting-guide  
错误：copywriting_guide、copywritingGuide、CopywritingGuide、copywriting guide

- Markdown 文件：英文小写（多个英文减号连接）；  
正确：copywriting-guide.md  
错误：copywriting_guide.md、copywritingGuide.md、CopywritingGuide.md、copywriting guide.md

- 图片
保存在 `images` 下，以被引用的文件为前缀，阿拉伯数字为后缀命名。