中文文案排版指南：提升开源项目文档质量

中文文案排版指南：提升开源项目文档质量

统一中文文案、排版的相关用法，降低团队成员之间的沟通成本，增强项目专业性和可读性。

📖 为什么需要文案排版规范？

在开源项目中，良好的文案排版不仅能够：

• 提升可读性：让读者更容易理解和阅读
• 增强专业性：体现项目的专业水准
• 降低沟通成本：减少因排版问题产生的误解
• 统一团队风格：保持项目文档的一致性

🔤 空格使用规范

「有研究显示，打字的时候不喜欢在中文和英文之间加空格的人，感情路都走得很辛苦，有七成的比例会在 34 岁的时候跟自己不爱的人结婚，而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。 与大家共勉之。」——vinta/paranoid-auto-spacing[1]

核心原则

• 中英文之间必须加空格
• 中文与数字之间必须加空格
• 数字与单位之间必须加空格
• 全角标点与其他字符之间不加空格

1. 中英文之间需要增加空格

正确示例：

在 GitCode 上，代码托管是围绕 Git 进行的。

错误示例：

在 GitCode 上，代码托管是围绕Git进行的。 在 GitCode 上，代码托管是围绕Git 进行的。

完整正确用法：

在 GitCode 上，代码托管是围绕 Git 进行的。每个 Repository 都包含了与 JSON 兼容的配置文件。代码是版本控制的，你不需要在每个 Commit 上提前指定存在哪些文件，只要直接提交对应的代码即可。

例外情况：「开源中国」等产品名词，按照官方所定义的格式书写。

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

正确示例：

这个开源项目已经获得了 5000 个 Star。

错误示例：

这个开源项目已经获得了 5000 个 Star。 这个开源项目已经获得了 5000 个 Star。

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

正确示例：

这个 API 的响应时间只有 10 ms，数据库查询需要 20 ms

错误示例：

这个 API 的响应时间只有 10ms，数据库查询需要 20ms

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

正确示例：

代码覆盖率达到了 90%，性能提升了 15%。

错误示例：

代码覆盖率达到了 90 %，性能提升了 15 %。

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

正确示例：

刚刚提交了一个 Pull Request，好开心！

错误示例：

刚刚提交了一个 Pull Request ，好开心！ 刚刚提交了一个 Pull Request， 好开心！

📝 标点符号使用规范

1. 不重复使用标点符号

虽然中国大陆的标点符号用法允许重复使用标点符号，但是这么做会破坏句子的美观性和专业性。

正确示例：

这个 Bug 终于修复了！ 你竟然说这个代码「完美」？！

错误示例：

这个 Bug 终于修复了！！ 这个 Bug 终于修复了！！！！！！！！ 你竟然说这个代码「完美」？？！！ 你竟然说这个代码「完美」？！？！？？！！

🔤 全角和半角使用规范

不明白什么是全角（全形）与半角（半形）符号？请查看维基百科条目『全角和半角[2]』。

1. 使用全角中文标点

正确示例：

嗨！你知道嘛？今天代码审查通过了「完美」了哎！ 什么是 Git 版本控制都不知道？Google it！

错误示例：

嗨! 你知道嘛? 今天代码审查通过了 "完美" 了哎！ 嗨!你知道嘛?今天代码审查通过了"完美"了哎！ 什么是 Git 版本控制都不知道? Google it! 什么是 Git 版本控制都不知道?Google it!

例外情况：中文句子内夹有英文书籍名、报刊名时，不应借用中文书名号，应以英文斜体表示。

2. 数字使用半角字符

正确示例：

这个项目已经运行了 1000 天。

错误示例：

这个项目已经运行了 １０００ 天。

例外情况：在设计稿、宣传海报中如出现极少量数字的情形时，为方便文字对齐，是可以使用全角数字的。

3. 英文整句使用半角标点

正确示例：

Linus 那句话是怎么说的？「Talk is cheap. Show me the code.」 推荐你阅读 _The Pragmatic Programmer: Your Journey to Mastery_，非常地有趣。

错误示例：

Linus 那句话是怎么说的？「Talk is cheap，show me the code。」 推荐你阅读《The Pragmatic Programmer：Your Journey to Mastery》，非常的有趣。

📚 名词使用规范

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

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

正确示例：

使用 GitCode 登录 我们的开源项目有 React、Flutter、仓颉。

2. 不要使用不地道的缩写

正确示例：

我们需要一位熟悉 TypeScript、ArkTS，至少理解一种框架（如 React、Flutter）的大前端开发者。

错误示例：

我们需要一位熟悉 Ts、arkts，至少理解一种框架（如 RJS、flutter）的 FED。

💡 争议性用法

以下用法略带有个人色彩，即：无论是否遵循下述规则，从语法的角度来讲都是正确的。

1. 链接之间增加空格

推荐用法：

请 提交一个 Pull Request[3] 并分配给相关维护者。 查看项目的最新更新，请 点击这里[4] 进行关注！

对比用法：

请提交一个 Pull Request[5]并分配给相关维护者。 查看项目的最新更新，请点击这里[6]进行关注！

2. 简体中文使用直角引号

推荐用法：

「开发者，『有条不紊』的『紊』是什么意思？」

对比用法：

"开发者，'有条不紊'的'紊'是什么意思？"

🛠️ 实用工具推荐

自动排版工具

• Pangu.js：自动在中英文之间添加空格
• Typora：Markdown 编辑器，支持自动排版
• VS Code 插件：Chinese (Simplified) Language Pack

检查清单

• [ ] 中英文之间是否有空格
• [ ] 数字与单位之间是否有空格
• [ ] 是否使用了全角中文标点
• [ ] 专有名词大小写是否正确
• [ ] 是否避免了不地道的缩写

📖 总结

遵循这些排版规范，可以让您的开源项目文档：

• 更加专业和易读
• 提升用户体验
• 体现团队的专业素养
• 降低沟通成本

记住：好的排版是尊重读者的表现！

参考资料

[1]

vinta/paranoid-auto-spacing: https://github.com/vinta/pangu.js

[2]

全角和半角: https://zh.wikipedia.org/wiki/全形和半形

[3]

提交一个 Pull Request: https://github.com/yourusername/opensource-guide

[4]

点击这里: https://github.com/yourusername/opensource-guide

[5]

提交一个 Pull Request: https://github.com/yourusername/opensource-guide

[6]

点击这里: https://github.com/yourusername/opensource-guide