中文文档编写规范（转载）

这篇文章转载自 GitHub，总结了中文文档的写作风格、标点符号、数值规范等方面的注意事项，适合作为中文写作的参考指南。

中文文档是指使用中文作为主要语言的文本文件，通常用于记录、传达或展示某种信息或知识。中文文档的编写需要遵循一定的规范，以保证文档的清晰、准确和一致。以下是一些常见的中文文档编写规范：

## 写作风格

- **语言简洁明了**。避免使用冗长、复杂或模糊的表达，尽量使用简单、直接或具体的词语。例如，不要写“在此之前”，而要写“先”；不要写“进行了一系列的探讨和研究”，而要写“探讨和研究了”。
- **语气平和客观**。避免使用过于主观、情绪化或评判性的语言，尽量使用中立、理性或事实性的语言。例如，不要写“这是一个非常重要的问题”，而要写“这是一个重要的问题”；不要写“这个方案是错误的”，而要写“这个方案有以下缺点”。
- **结构清晰有序**。遵循逻辑顺序，按照主题、目的、方法、结果和结论的顺序组织文档内容。使用标题、列表、表格、图表等方式，对文档内容进行分段、分点或分层，以便于阅读和理解。例如，不要写“我们先介绍了背景，然后分析了问题，最后提出了解决方案”，而要写“本文的结构如下：第一部分介绍了背景，第二部分分析了问题，第三部分提出了解决方案”。
- **格式统一规范**。遵循一致的格式标准，对文档的字体、字号、颜色、对齐、缩进、间距、编号等进行规范化，以保证文档的美观和整洁。使用样式表、模板或工具，对文档的格式进行统一管理和调整。例如，不要使用不同的字体或字号，而要使用统一的样式表；不要手动调整文档的对齐或缩进，而要使用自动的工具。

## 标点符号

- **使用全角标点符号**。除了英文单词、数字或代码等特殊情况，其他情况下使用全角标点符号，以与中文字符保持一致。例如，不要写“这是一个问题?”,而要写“这是一个问题？”。
- **使用中文标点符号**。除了引用英文原文或符合英文习惯的特殊情况，其他情况下使用中文标点符号，以与中文语言保持一致。例如，不要写“这是一个“问题”？”，而要写“这是一个‘问题’？”。
- **正确使用标点符号**。根据标点符号的功能和含义，选择合适的标点符号，并遵循标点符号的使用规则。例如，不要写“这是一个问题，”，而要写“这是一个问题。”；不要写“这是一个问题。？”，而要写“这是一个问题？”。

## 数值规范

- **使用阿拉伯数字**。除了表示序号、年代或口语化的特殊情况，其他情况下使用阿拉伯数字，以便于识别和计算。例如，不要写“一百二十三”，而要写“123”；不要写“2023年”，而要写“2023年”。
- **使用千分位分隔符**。对于四位或以上的整数，使用半角逗号作为千分位分隔符，以便于阅读和理解。例如，不要写“123456789”，而要写“123,456,789”。
- **使用小数点**。对于小数，使用半角句号作为小数点，以与英文数字保持一致。例如，不要写“3，14”，而要写“3.14”。
- **使用百分号**。对于百分数，使用半角百分号，并与数字之间留有一个空格，以与英文数字保持一致。例如，不要写“50%”，而要写“50 %”。
- **使用单位符号**。对于带有单位的数值，使用半角单位符号，并与数字之间留有一个空格，以与英文数字保持一致。例如，不要写“10kg”，而要写“10 kg”；不要写“5℃”，而要写“5 ℃”。

以上是一些中文文档编写规范的简要介绍，更多的细节和示例可以参考 GitHub 上的 [中文文档写作规范] 项目，该项目是由 [ruanyf] 发起并维护的一个开源项目，旨在为中文文档的编写提供一个统一的标准和参考。希望本文能够对中文文档的编写有所帮助，也欢迎大家对该项目提出意见和建议，共同推动中文文档的质量和水平。

: https://github.com/ruanyf/document-style-guide
: https://github.com/ruanyf