[中文文档编写规范(转载)](^2^):这篇文章转载了阮一峰老师的一篇博客,总结了中文文档的写作规范,包括标题、文本、段落、引用、数值和标点符号等方面。
[中文文档编写规范(转载)](^2^):这篇文章转载了阮一峰老师的一篇博客,总结了中文文档的写作规范,包括标题、文本、段落、引用、数值和标点符号等方面。软件开发文档编写要求修订
中文文档编写规范(转载):这篇文章转载了阮一峰老师的一篇博客,总结了中文文档的写作规范,包括标题、文本、段落、引用、数值和标点符号等方面。文章的内容非常实用,适合任何需要撰写中文文档的人员参考。下面是文章的摘要和部分内容。写好规范字文章
## 摘要军用文档编写规范指导
本文介绍了中文文档的基本规范,包括以下几个方面:
- 标题规范:如何设置标题的层级和原则
- 文本规范:如何使用字间距、句子和写作风格
- 段落规范:如何组织段落的结构和语气
- 引用规范:如何引用第三方内容和注明出处
- 数值规范:如何使用半角数字、千分号、货币符号和数值范围
- 标点符号规范:如何使用全角标点符号和注意事项
## 标题规范
标题是文档的重要组成部分,它能够概括文章的主题和内容,方便读者快速浏览和查找。因此,标题应该遵循以下几个原则:
- 层级:标题分为四级,一级标题为文章的标题,二级标题为文章主要部分的大标题,三级标题为二级标题下面一级的小标题,四级标题为三级标题下面某一方面的小标题。例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
- 原则:
- 一级标题下,不能直接出现三级标题。例如:
# 一级标题
### 三级标题
这样的结构是错误的,缺少二级标题。
- 标题要避免孤立编号(即同级标题只有一个)。例如:
## 二级标题 A
### 三级标题 A
## 二级标题 B
这样的结构是不合理的,二级标题 A 只包含一个三级标题,完全可以省略三级标题 A。
- 下级标题不重复上一级标题的名字。例如:
## 概述
### 概述
这样的结构是冗余的,建议避免。
- 谨慎使用四级标题,尽量避免出现,保持层级的简单,防止出现过于复杂的章节。如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。例如:
### 三级标题
#### 四级标题 A
#### 四级标题 B
#### 四级标题 C
这样的结构可以改为:
### 三级标题
- **A**
- **B**
- **C**
## 文本规范
文本是文档的主体部分,它需要清晰地表达作者的思想和观点,同时也要考虑读者的阅读体验和习惯。因此,文本应该遵循以下几个原则:
- 字间距:
- 全角中文字符与半角英文字符之间,应有一个半角空格。例如:
错误:本文介绍如何快速启动Windows系统。
正确:本文介绍如何快速启动 Windows 系统。
- 全角中文字符与半角阿拉伯数字之间,有没有半角空格都可,但必须保证风格统一,不能两种风格混杂。例如:
正确:2011年5月15日,我订购了5台笔记本电脑与10台平板电脑。
正确:2011 年 5 月 15 日,我订购了 5 台笔记本电脑与 10 台平板电脑。
半角的百分号,视同阿拉伯数字。例如:
正确:今年我国经济增长率是6.5%。
正确:今年我国经济增长率是 6.5%。
- 英文单位若不翻译,单位前的阿拉伯数字与单位符号之间,应留出适当的空隙。例如:
一部容量为 16 GB 的智能手机
1 h = 60 min = 3,600 s
- 半角英文字符和半角阿拉伯数字,与全角标点符号之间不留空格。例如:
错误:他的电脑是 MacBook Air 。
正确:他的电脑是 MacBook Air。
- 句子:
- 避免使用长句。不包含任何标点符号的单个句子,或者以逗号分隔的句子构件,长度尽量保持在 20 个字以内;20~29 个字的句子,可以接受;30~39 个字的句子,语义必须明确,才能接受;多于 40 个字的句子,任何情况下都不能接受。例如:
错误:本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
正确:本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),还是由多台服务器(并行处理结构)进行动作控制,均可以使用本产品。
逗号分割的长句,总长度不应该超过 100 字或者正文的 3 行。
- 尽量使用简单句和并列句,避免使用复合句。例如:
并列句:他昨天生病了,没有参加会议。
复合句:那个昨天生病的人没有参加会议。
- 同样一个意思,尽量使用肯定句表达,不使用否定句表达。例如:
错误:请确认没有接通装置的电源。
正确:请确认装置的电源已关闭。
- 避免使用双重否定句。例如:
错误:没有删除权限的用户,不能删除此文件。
正确:用户必须拥有删除权限,才能删除此文件。
- 写作风格:
- 尽量不使用被动语态,改为使用主动语态。例如:
被动语态:文件可以通过本软件打开。
主动语态:本软件可以打开文件。
中文文档编写规范(转载):这篇文章转载了阮一峰老师的一篇博客,总结了中文文档的写作规范,包括标题、文本、段落、引用、数值和标点符号等方面。文章的内容非常实用,适合任何需要撰写中文文档的人员参考。下面是文章的摘要和部分内容。写好规范字文章
## 摘要军用文档编写规范指导
本文介绍了中文文档的基本规范,包括以下几个方面:
- 标题规范:如何设置标题的层级和原则
- 文本规范:如何使用字间距、句子和写作风格
- 段落规范:如何组织段落的结构和语气
- 引用规范:如何引用第三方内容和注明出处
- 数值规范:如何使用半角数字、千分号、货币符号和数值范围
- 标点符号规范:如何使用全角标点符号和注意事项
## 标题规范
标题是文档的重要组成部分,它能够概括文章的主题和内容,方便读者快速浏览和查找。因此,标题应该遵循以下几个原则:
- 层级:标题分为四级,一级标题为文章的标题,二级标题为文章主要部分的大标题,三级标题为二级标题下面一级的小标题,四级标题为三级标题下面某一方面的小标题。例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
- 原则:
- 一级标题下,不能直接出现三级标题。例如:
# 一级标题
### 三级标题
这样的结构是错误的,缺少二级标题。
- 标题要避免孤立编号(即同级标题只有一个)。例如:
## 二级标题 A
### 三级标题 A
## 二级标题 B
这样的结构是不合理的,二级标题 A 只包含一个三级标题,完全可以省略三级标题 A。
- 下级标题不重复上一级标题的名字。例如:
## 概述
### 概述
这样的结构是冗余的,建议避免。
- 谨慎使用四级标题,尽量避免出现,保持层级的简单,防止出现过于复杂的章节。如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。例如:
### 三级标题
#### 四级标题 A
#### 四级标题 B
#### 四级标题 C
这样的结构可以改为:
### 三级标题
- **A**
- **B**
- **C**
## 文本规范
文本是文档的主体部分,它需要清晰地表达作者的思想和观点,同时也要考虑读者的阅读体验和习惯。因此,文本应该遵循以下几个原则:
- 字间距:
- 全角中文字符与半角英文字符之间,应有一个半角空格。例如:
错误:本文介绍如何快速启动Windows系统。
正确:本文介绍如何快速启动 Windows 系统。
- 全角中文字符与半角阿拉伯数字之间,有没有半角空格都可,但必须保证风格统一,不能两种风格混杂。例如:
正确:2011年5月15日,我订购了5台笔记本电脑与10台平板电脑。
正确:2011 年 5 月 15 日,我订购了 5 台笔记本电脑与 10 台平板电脑。
半角的百分号,视同阿拉伯数字。例如:
正确:今年我国经济增长率是6.5%。
正确:今年我国经济增长率是 6.5%。
- 英文单位若不翻译,单位前的阿拉伯数字与单位符号之间,应留出适当的空隙。例如:
一部容量为 16 GB 的智能手机
1 h = 60 min = 3,600 s
- 半角英文字符和半角阿拉伯数字,与全角标点符号之间不留空格。例如:
错误:他的电脑是 MacBook Air 。
正确:他的电脑是 MacBook Air。
- 句子:
- 避免使用长句。不包含任何标点符号的单个句子,或者以逗号分隔的句子构件,长度尽量保持在 20 个字以内;20~29 个字的句子,可以接受;30~39 个字的句子,语义必须明确,才能接受;多于 40 个字的句子,任何情况下都不能接受。例如:
错误:本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
正确:本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),还是由多台服务器(并行处理结构)进行动作控制,均可以使用本产品。
逗号分割的长句,总长度不应该超过 100 字或者正文的 3 行。
- 尽量使用简单句和并列句,避免使用复合句。例如:
并列句:他昨天生病了,没有参加会议。
复合句:那个昨天生病的人没有参加会议。
- 同样一个意思,尽量使用肯定句表达,不使用否定句表达。例如:
错误:请确认没有接通装置的电源。
正确:请确认装置的电源已关闭。
- 避免使用双重否定句。例如:
错误:没有删除权限的用户,不能删除此文件。
正确:用户必须拥有删除权限,才能删除此文件。
- 写作风格:
- 尽量不使用被动语态,改为使用主动语态。例如:
被动语态:文件可以通过本软件打开。
主动语态:本软件可以打开文件。
版权声明:本文来源于互联网,不代表本站立场与观点,临夏教育无任何盈利行为和商业用途,如有错误或侵犯利益请联系我们。