中文文档编写规范（转载）：这篇文章转载自 GitHub，总结了中文文档的写作规范，包括标题、文本、数值、标点符号等方面的注意事项。

中文文档是指使用中文作为主要语言的书面材料，如文章、报告、说明书、教程等。中文文档的编写需要遵循一定的规范，以保证内容的清晰、准确和统一。本文参考了 GitHub 上的 [Chinese Copywriting Guidelines] 项目，总结了以下几个方面的中文文档编写规范：

## 标题

- 标题应该使用**一级标题**（`#`）或**二级标题**（`##`）的格式，不要使用其他级别的标题。
- 标题应该简明扼要，反映出文档的主要内容或目的。
- 标题应该使用**中文全角冒号**（`：`）而不是英文半角冒号（`:`）来分隔主副标题。
- 标题应该在冒号后面留一个空格，以增加可读性。
- 标题应该避免使用标点符号，除非必要。

## 文本

- 文本应该使用**中文全角标点符号**（如 `。` `，` `！` `？` `“”` `（）` 等），而不是英文半角标点符号（如 `.`, `,`, `!`, `?`, `"`, `()` 等）。
- 文本应该在每个句子结束后留一个空格，以增加可读性。
- 文本应该在每个段落结束后留一个空行，以增加可读性。
- 文本应该避免使用过长的句子或段落，以免造成阅读困难。
- 文本应该使用**正确的语法**和**规范的用词**，避免出现错别字、语病或歧义。
- 文本应该使用**简体中文**而不是繁体中文，除非特殊情况。

## 数值

- 数值应该使用**阿拉伯数字**而不是汉字数字，除非特殊情况。
- 数值应该在小数点后保留两位有效数字，除非特殊情况。
- 数值应该在千位以上使用逗号分隔，以增加可读性。
- 数值应该在单位前留一个空格，以增加可读性。
- 数值应该使用国际通用的单位制度，如米、千克、秒等，除非特殊情况。

## 引用

- 引用应该使用**引用块**（`>`）的格式，以区分原文和引用内容。
- 引用应该在引用块前后留一个空行，以增加可读性。
- 引用应该注明出处和作者，以尊重版权和知识产权。

## 列表

- 列表应该使用**无序列表**（`*`）或**有序列表**（`1.`）的格式，以区分不同的项目。
- 列表应该在列表前后留一个空行，以增加可读性。
- 列表应该在每个项目后面留一个空格，以增加可读性。
- 列表应该在每个项目结束后使用句号或分号，以保持一致性。

## 表格

- 表格应该使用**表格格式**（`|` 和 `-`）来创建和显示数据或信息。
- 表格应该在表头和表身之间使用一行分隔符（`| --- | --- | --- |`），以区分不同的部分。
- 表格应该在每个单元格内部对齐数据或信息，以增加可读性。
- 表格应该在每个单元格之间使用竖线分隔（`|`），以区分不同的列。

## 代码

- 代码应该使用**代码块**（`` ``` ``）或**行内代码**（`` ` ``）的格式，以区分文本和代码内容。
- 代码应该在代码块前后留一个空行，以增加可读性。
- 代码应该在代码块内部使用合适的语言标识（如 `python`, `java`, `html` 等），以实现语法高亮和格式化。
- 代码应该遵循相应的编码规范，如缩进、注释、变量命名等，以保证代码的清晰、准确和统一。

以上是中文文档编写规范的一些要点，希望对你有所帮助。如果你想了解更多的细节和示例，请参考 [Chinese Copywriting Guidelines] 项目。祝你写作愉快！