Documentation
README
中文技术文档写作规范
概述
中文技术文档最常见的问题不是内容不够,而是读起来别扭——中英文挤在一起没有空格、全角半角混用、一股机翻味。本技能提供一套完整的中文技术文档写作规范,让你的文档专业、好读、不出戏。
核心原则: 排版服务于阅读体验,规范服务于一致性,内容服务于读者。
参考标准: 中文文案排版指北
中文排版规范
空格
中英文之间加空格:
# 好
使用 Git 进行版本管理,配合 Jenkins 实现持续集成。
# 坏
使用Git进行版本管理,配合Jenkins实现持续集成。
中文与数字之间加空格:
# 好
本次更新包含 3 个新功能和 12 个 Bug 修复。
# 坏
本次更新包含3个新功能和12个Bug修复。
数字与单位之间加空格:
# 好
文件大小不超过 5 MB,响应时间控制在 200 ms 以内。
# 坏
文件大小不超过5MB,响应时间控制在200ms以内。
例外:度数、百分比等不加空格:
# 好
今天气温 32°C,CPU 使用率 95%。
# 坏
今天气温 32 °C,CPU 使用率 95 %。
链接前后加空格:
# 好
请参考 [官方文档](https://example.com) 获取更多信息。
# 坏
请参考[官方文档](https://example.com)获取更多信息。
标点符号
中文语境使用全角标点:
This is the opening of the README. Read the full README on GitHub.