中文文档编写规范（转载）：这篇文章转载自 GitHub，总结了中文文档的写作风格、标点符号、数值规范等方面的注意事项，对于提高中文文档的质量和可读性有很大帮助。

中文文档是指使用中文作为主要语言的书面材料，包括但不限于技术文档、用户手册、教程、博客、论文等。中文文档的编写需要遵循一定的规范，以保证内容的准确性、清晰性和一致性。以下是一些常见的中文文档编写规范，供参考和学习。

## 写作风格

- **语言文字**：使用简体中文作为主要语言，避免使用繁体字、方言词汇或外来语。如果必须使用外来语，应该用括号注明原文和译文，例如：**API**（Application Programming Interface，应用程序编程接口）。
- **语气语态**：使用正式、客观、简洁的语气，避免使用过于口语化、感情化或模糊的表达。使用主动语态，避免使用被动语态。例如：不要说“本文档将会介绍……”，而要说“本文档介绍……”。
- **句子结构**：使用简单句和并列句，避免使用复杂句和从句。每个句子应该只包含一个主要信息点，避免使用过长或过短的句子。例如：不要说“本节将会讲述如何安装和配置软件，并且提供一些常见问题的解决方法”，而要说“本节讲述如何安装和配置软件。本节还提供一些常见问题的解决方法。”
- **段落结构**：使用清晰的段落结构，每个段落应该有一个主题句和若干支持句。段落之间应该有逻辑上的联系和过渡，避免使用无关或重复的内容。段落的长度应该适中，不要超过十行。
- **标题结构**：使用层次分明的标题结构，每个标题应该反映出其下内容的主要主题。标题应该简明扼要，不要超过十个字。标题之间应该有递进或并列的关系，避免使用交叉或重复的标题。标题应该按照一定的格式标记，例如：一级标题用“#”，二级标题用“##”，以此类推。

## 标点符号

- **全角半角**：使用全角（两字节）标点符号，避免使用半角（一字节）标点符号。例如：不要说“Hello, world!”，而要说“你好，世界！”
- **逗号顿号**：使用逗号（，）分隔句子内部的成分，使用顿号（、）分隔并列的词语或短语。例如：不要说“我喜欢吃苹果,香蕉,橘子”，而要说“我喜欢吃苹果、香蕉、橘子”。
- **句号问号感叹号**：使用句号（。）结束陈述句或祈使句，使用问号（？）结束疑问句，使用感叹号（！）结束感叹句。每个标点符号后面应该留一个空格，除非是行末或段末。例如：不要说“你好吗?我很好!”，而要说“你好吗？ 我很好！”
- **引号括号**：使用双引号（“”）表示引用的内容，使用单引号（‘’）表示引用内的引用。使用圆括号（（））表示补充或说明的内容，使用方括号（[ ]）表示注释或参考的内容。引号和括号应该成对出现，左右对称。例如：不要说“他说:‘我是’小明’’”，而要说“他说：‘我是“小明”’”。
- **冒号分号**：使用冒号（：）表示引出下文的内容，使用分号（；）表示分隔并列的句子。冒号和分号后面应该留一个空格，除非是行末或段末。例如：不要说“他说:我是小明”，而要说“他说： 我是小明”。
- **破折号省略号**：使用破折号（——）表示转折或补充的内容，使用省略号（……）表示省略或停顿的内容。破折号和省略号应该占两个字符的宽度，两边不留空格。例如：不要说“他说-我是小明……”，而要说“他说——我是小明……”。

## 数值规范

- **数字格式**：使用阿拉伯数字表示数值，避免使用汉字数字或罗马数字。数字应该按照千位分隔符（,）进行分组，小数点（.）后面最多保留两位有效数字。例如：不要说“一千零一点二三”，而要说“1,001.23”。
- **单位格式**：使用国际标准单位制（SI）表示物理量，避免使用非标准单位或缩写。单位应该紧跟在数字后面，中间不留空格，除非是度（°）、百分比（%）或角度（′″）。例如：不要说“1000米/秒”，而要说“1,000 m/s”。
- **日期格式**：使用公历日期表示时间，避免使用农历日期或其他历法。日期应该按照年-月-日（YYYY-MM-DD）的顺序书写，中间用短横线（-）分隔，两边不留空格。例如：不要说“二零二三年十月二十九日”，而要说“2023-10-29”。
- **时间格式**：使用24小时制表示时间，避免使用12小时制或其他制式。时间应该按照时:分:秒（HH:MM:SS）的顺序书写，中间用冒号（:）分隔，两边不留空格。如果需要表示时区，可以在时间后面加上时区缩写或时差。例如：不要说“上午十点十三分三十二秒”，而要说“10:13:32 CST”或“10:13:32 +08:00”。

以上就是一些中文文档编写规范的简介，希望对你有所帮助。如果你想了解更多细节和示例，请参考[原文](^2^)。谢谢你的阅读！