中文文档编写规范（转载）软件开发文档编写要求修订

这篇文章转载了阮一峰老师的博客，总结了中文文档的写作风格、标点符号、数值规范等方面的注意事项，适合各类中文文档的编写者参考。文件编写格式规程

阮一峰老师是一位知名的程序员和技术作家，他的博客[ruanyifeng.com](^1^)收录了他多年来的技术文章和思考，涵盖了前端开发、后端开发、区块链、人工智能等多个领域。他的文章通俗易懂，风格清新，深受读者喜爱。第一文档

在他的博客中，有一篇文章叫做《[中文技术文档的写作规范](^2^)》，是他根据自己的写作经验和参考其他优秀文档，总结出来的一套中文文档编写规范。这篇文章不仅适用于技术文档，也适用于其他类型的中文文档，因为它涉及了中文写作的基本原则和细节。

文章分为以下几个部分：

- 标题
- 文本
- 列表
- 表格
- 代码
- 链接
- 图片
- 标点符号
- 数值
- 缩略词
- 专有名词
- 附录

每个部分都给出了具体的规则和示例，让读者可以清楚地理解和遵循。以下是一些摘要：

- 标题：使用阿拉伯数字作为标题编号，不使用汉字数字或罗马数字；标题层级不超过四级；标题要简明扼要，不能超过 15 个字；标题末尾不加标点符号。
- 文本：使用第三人称，避免使用第一人称和第二人称；使用简体中文，不使用繁体中文；使用正式语言，避免使用口语或方言；使用主动语态，避免使用被动语态；使用现在时态，避免使用过去时态或将来时态；段落之间空一行；每行文字不超过 120 个字符。
- 列表：无序列表使用圆点符号（•）作为标记；有序列表使用阿拉伯数字和英文句点（.）作为标记；子列表相对于父列表缩进四个空格；列表项之间不空行；列表项可以是单个词语、短语或句子，如果是句子，要以句号结尾。
- 表格：表格必须有表头；表头单元格必须居中对齐；其他单元格必须左对齐；单元格内换行使用
标签；单元格内如果有列表或代码块，要缩进四个空格。
- 代码：代码块之前空一行，之后空一行；代码块必须指定语言类型；代码块内不得有多余的空行或空格；代码块内如果有注释，要用英文撰写，并且在注释符号后空一格。
- 链接：链接必须直接给出网址或网址对应的文字，不能给出二维码或其他形式的间接链接；链接文字要清晰明确，不能使用“点击这里”、“详见此处”等模糊不清的文字。
- 图片：图片必须有相应的替代文字（alt text），用于描述图片内容或功能；图片必须放在合适的位置，不能影响正文的阅读流畅度；图片必须有清晰的来源和版权信息，不能随意使用他人的图片。
- 标点符号：使用全角中文标点符号，不使用半角英文标点符号；句号、问号、感叹号、逗号、顿号、分号、冒号结尾的句子，后面必须空一格，然后再写下一句；引号里面的内容，如果是完整的句子，句末的标点符号放在引号里面；如果不是完整的句子，句末的标点符号放在引号外面；省略号表示语气的停顿，用三个全角圆点（……）表示；省略号表示省略内容，用六个全角圆点（…………）表示。
- 数值：使用半角阿拉伯数字表示数值，不使用全角数字或汉字数字；小数点用半角英文句点（.）表示，不用全角中文句点（。）表示；千分位分隔符用半角英文逗号（,）表示，不用全角中文逗号（，）表示；百分比用半角英文百分号（%）表示，不用全角中文百分号（％）表示；度数用半角英文度符号（°）表示，不用全角中文度符号（°）表示。
- 缩略词：缩略词必须首次出现时给出完整的英文原词和中文翻译，并在括号内注明缩略词；缩略词必须使用大写字母，并且不加任何标点符号。
- 专有名词：专有名词必须使用正确的大小写和拼写；专有名词如果有官方的中文翻译或通用的中文译名，要优先使用中文，并在首次出现时注明英文原名；专有名词如果没有官方或通用的中文翻译或译名，要使用英文原名，并在首次出现时注明中文意思。
- 附录：附录放在正文之后，每个附录为一个二级标题；附录编号使用大写字母 A、B、C……表示；附录标题格式为“附录 A：[标题]”。

以上是《中文技术文档的写作规范》这篇文章的主要内容。这些规范可以帮助我们编写出规范、清晰、易读的中文文档，提高我们的沟通效率和质量。建议大家阅读原文，并尝试在自己的写作中应用这些规范。