[中文文档编写规范(转载)](^2^):这篇文章转载了阮一峰老师的博客,总结了中文文档的写作风格、标点符号、数值规范等方面的注意事项。
中文文档编写规范(转载):这篇文章转载了阮一峰老师的博客,总结了中文文档的写作风格、标点符号、数值规范等方面的注意事项。软件开发文档编写要求修订
中文文档是指使用中文作为主要语言的书面材料,包括但不限于书籍、报告、论文、文章、网页等。中文文档的编写需要遵循一定的规范,以保证内容的清晰、准确和统一。本文转载了阮一峰老师的博客,总结了中文文档的编写规范,供参考和学习。文件编写格式规程
## 写作风格标准编写格式
- **正式**:中文文档应该使用正式的语言,避免使用口语化、俚语或者网络用语。例如,不要使用“嗯”、“啊”、“哈哈”等表示情感或者语气的词语,也不要使用“你”、“我”、“他”等人称代词,而应该使用“读者”、“作者”、“某某人”等。
- **简洁**:中文文档应该使用简洁的语言,避免使用冗长、复杂或者重复的表达。例如,不要使用“基于……的……”、“……是……之一”、“……是……的一个重要组成部分”等模糊或者冗余的词语,也不要使用“本着……的精神”、“在……方面”、“对于……来说”等修饰性的短语。
- **明确**:中文文档应该使用明确的语言,避免使用模棱两可、含糊不清或者错误的表达。例如,不要使用“可能”、“大概”、“或许”等表示不确定性的词语,也不要使用“很多”、“少数”、“大部分”等表示数量的词语,而应该使用具体的数字或者百分比。
- **逻辑**:中文文档应该使用逻辑的语言,避免使用无关联、无顺序或者无论证的表达。例如,不要使用“因为……所以……”、“如果……那么……”等表示因果关系的词语,而没有给出具体的原因或者结果,也不要使用“首先……其次……最后……”等表示顺序关系的词语,而没有给出具体的步骤或者结论。
## 标点符号
- **全角**:中文文档应该使用全角(占两个字节)的标点符号,避免使用半角(占一个字节)的标点符号。例如,不要使用`.`、`,`、`?`、`!`等半角标点符号,而应该使用`。`、`,`、`?`、`!`等全角标点符号。
- **空格**:中文文档应该在全角标点符号和英文字母、数字之间添加一个空格,避免出现紧密排列或者断行的情况。例如,“这是一个例子:Hello World!”而不是“这是一个例子:Hello World!”或者“这是一个例子: Hello World!”。
- **引号**:中文文档应该使用双引号(“ ”)表示引用或者强调的内容,避免使用单引号(‘ ’)或者其他符号。例如,“他说:“我很喜欢这本书。”而不是‘他说:“我很喜欢这本书。”’或者『他说:“我很喜欢这本书。”』。
- **括号**:中文文档应该使用圆括号(( ))表示补充或者说明的内容,避免使用方括号([ ])或者花括号({ })。例如,“这本书的作者是(阮一峰)。”而不是“这本书的作者是[阮一峰]。”或者“这本书的作者是{阮一峰}。”。
- **破折号**:中文文档应该使用破折号(——)表示转折或者插入的内容,避免使用连字符(-)或者其他符号。例如,“这本书很有趣——至少我是这么认为的。”而不是“这本书很有趣-至少我是这么认为的。”或者“这本书很有趣……至少我是这么认为的。”。
## 数值规范
- **数字**:中文文档应该使用阿拉伯数字(0-9)表示数值,避免使用汉字数字(零-九)或者其他符号。例如,“这本书有100页。”而不是“这本书有一百页。”或者“这本书有①⓪⓪页。”。
- **单位**:中文文档应该使用国际标准单位(SI)表示物理量,避免使用非标准单位或者其他符号。例如,“这本书的重量是1千克。”而不是“这本书的重量是2.2磅。”或者“这本书的重量是1kg。”。
- **百分比**:中文文档应该使用百分号(%)表示百分比,避免使用分数或者其他符号。例如,“这本书的评分是90%。”而不是“这本书的评分是9/10。”或者“这本书的评分是90‰。”。
- **小数点**:中文文档应该使用小数点(.)表示小数,避免使用逗号(,)或者其他符号。例如,“这本书的价格是9.99元。”而不是“这本书的价格是9,99元。”或者“这本书的价格是9·99元。”。
- **千位分隔符**:中文文档应该使用逗号(,)表示千位分隔符,避免使用空格或者其他符号。例如,“这本书的销量是1,000,000册。”而不是“这本书的销量是1000000册。”或者“这本书的销量是1 000 000册。”
以上就是中文文档编写规范的一些要点,希望对读者有所帮助。更多详细内容,请参考阮一峰老师的博客。
: [中文技术文档写作规范]
中文文档是指使用中文作为主要语言的书面材料,包括但不限于书籍、报告、论文、文章、网页等。中文文档的编写需要遵循一定的规范,以保证内容的清晰、准确和统一。本文转载了阮一峰老师的博客,总结了中文文档的编写规范,供参考和学习。文件编写格式规程
## 写作风格标准编写格式
- **正式**:中文文档应该使用正式的语言,避免使用口语化、俚语或者网络用语。例如,不要使用“嗯”、“啊”、“哈哈”等表示情感或者语气的词语,也不要使用“你”、“我”、“他”等人称代词,而应该使用“读者”、“作者”、“某某人”等。
- **简洁**:中文文档应该使用简洁的语言,避免使用冗长、复杂或者重复的表达。例如,不要使用“基于……的……”、“……是……之一”、“……是……的一个重要组成部分”等模糊或者冗余的词语,也不要使用“本着……的精神”、“在……方面”、“对于……来说”等修饰性的短语。
- **明确**:中文文档应该使用明确的语言,避免使用模棱两可、含糊不清或者错误的表达。例如,不要使用“可能”、“大概”、“或许”等表示不确定性的词语,也不要使用“很多”、“少数”、“大部分”等表示数量的词语,而应该使用具体的数字或者百分比。
- **逻辑**:中文文档应该使用逻辑的语言,避免使用无关联、无顺序或者无论证的表达。例如,不要使用“因为……所以……”、“如果……那么……”等表示因果关系的词语,而没有给出具体的原因或者结果,也不要使用“首先……其次……最后……”等表示顺序关系的词语,而没有给出具体的步骤或者结论。
## 标点符号
- **全角**:中文文档应该使用全角(占两个字节)的标点符号,避免使用半角(占一个字节)的标点符号。例如,不要使用`.`、`,`、`?`、`!`等半角标点符号,而应该使用`。`、`,`、`?`、`!`等全角标点符号。
- **空格**:中文文档应该在全角标点符号和英文字母、数字之间添加一个空格,避免出现紧密排列或者断行的情况。例如,“这是一个例子:Hello World!”而不是“这是一个例子:Hello World!”或者“这是一个例子: Hello World!”。
- **引号**:中文文档应该使用双引号(“ ”)表示引用或者强调的内容,避免使用单引号(‘ ’)或者其他符号。例如,“他说:“我很喜欢这本书。”而不是‘他说:“我很喜欢这本书。”’或者『他说:“我很喜欢这本书。”』。
- **括号**:中文文档应该使用圆括号(( ))表示补充或者说明的内容,避免使用方括号([ ])或者花括号({ })。例如,“这本书的作者是(阮一峰)。”而不是“这本书的作者是[阮一峰]。”或者“这本书的作者是{阮一峰}。”。
- **破折号**:中文文档应该使用破折号(——)表示转折或者插入的内容,避免使用连字符(-)或者其他符号。例如,“这本书很有趣——至少我是这么认为的。”而不是“这本书很有趣-至少我是这么认为的。”或者“这本书很有趣……至少我是这么认为的。”。
## 数值规范
- **数字**:中文文档应该使用阿拉伯数字(0-9)表示数值,避免使用汉字数字(零-九)或者其他符号。例如,“这本书有100页。”而不是“这本书有一百页。”或者“这本书有①⓪⓪页。”。
- **单位**:中文文档应该使用国际标准单位(SI)表示物理量,避免使用非标准单位或者其他符号。例如,“这本书的重量是1千克。”而不是“这本书的重量是2.2磅。”或者“这本书的重量是1kg。”。
- **百分比**:中文文档应该使用百分号(%)表示百分比,避免使用分数或者其他符号。例如,“这本书的评分是90%。”而不是“这本书的评分是9/10。”或者“这本书的评分是90‰。”。
- **小数点**:中文文档应该使用小数点(.)表示小数,避免使用逗号(,)或者其他符号。例如,“这本书的价格是9.99元。”而不是“这本书的价格是9,99元。”或者“这本书的价格是9·99元。”。
- **千位分隔符**:中文文档应该使用逗号(,)表示千位分隔符,避免使用空格或者其他符号。例如,“这本书的销量是1,000,000册。”而不是“这本书的销量是1000000册。”或者“这本书的销量是1 000 000册。”
以上就是中文文档编写规范的一些要点,希望对读者有所帮助。更多详细内容,请参考阮一峰老师的博客。
: [中文技术文档写作规范]
版权声明:本文来源于互联网,不代表本站立场与观点,临夏教育无任何盈利行为和商业用途,如有错误或侵犯利益请联系我们。