《中文文档编写规范(转载)》[^2^]:这篇文章是转载自 GitHub 的,总结了一些中文文档的写作规范,涉及标题、文本、段落、引用、数值、标点符号等方面的注意
《中文文档编写规范(转载)》:这篇文章是转载自 GitHub 的,总结了一些中文文档的写作规范,涉及标题、文本、段落、引用、数值、标点符号等方面的注意事项。
中文文档编写规范(转载)
中文文档是指使用中文作为主要语言的文本文件,通常用于记录、传达或展示某种信息或知识。中文文档的编写需要遵循一定的规范,以保证文档的清晰、准确、规范和易读。本文是转载自 GitHub 的一篇文章,总结了一些中文文档的写作规范,涉及标题、文本、段落、引用、数值、标点符号等方面的注意事项。希望对中文文档的编写者有所帮助。
## 标题
标题是文档的重要组成部分,它可以概括文档的主题和内容,吸引读者的注意力,引导读者阅读。标题的编写应遵循以下原则:
- 标题应简洁明了,能够反映文档的核心内容,避免使用冗长、模糊或无关的词语。
- 标题应使用中文,除非是专有名词或无法翻译的词语,如“GitHub”、“Python”等。
- 标题应使用正确的语法和标点符号,遵循中文的语序和习惯,避免使用英文的语法和标点符号,如“?”、“!”等。
- 标题应使用一级标题(#)作为文档的主标题,使用二级标题(##)或更低级别的标题(###、####等)作为文档的子标题,标题的层级应递进且不跳跃,如不应使用“#”后直接使用“###”。
- 标题应使用中文全角的冒号(:)作为标题的后缀,而不是英文半角的冒号(:),如“标题:”而不是“标题:”。
## 文本
文本是文档的主体部分,它可以表达文档的详细内容,传递信息或知识,引发思考或讨论。文本的编写应遵循以下原则:
- 文本应使用中文,除非是专有名词或无法翻译的词语,如“GitHub”、“Python”等。
- 文本应使用正确的语法和标点符号,遵循中文的语序和习惯,避免使用英文的语法和标点符号,如“?”、“!”等。
- 文本应使用中文全角的标点符号,如“,”、“。”、“()”等,而不是英文半角的标点符号,如“,”、“.”、“()”等。
- 文本应使用中文全角的引号(“”)作为引用或强调的标志,而不是英文半角的引号("")或其他符号,如“*”、“_”等。
- 文本应使用中文全角的空格( )作为词语之间的间隔,而不是英文半角的空格( ),如“中文 文档”而不是“中文文档”。
- 文本应使用中文全角的数字(0、1、2等)作为数值的表示,而不是英文半角的数字(0、1、2等),如“300”而不是“300”。
- 文本应使用中文全角的百分号(%)作为百分比的表示,而不是英文半角的百分号(%),如“50%”而不是“50%”。
- 文本应使用中文全角的单位符号(㎡、℃等)作为单位的表示,而不是英文半角的单位符号(m2、C等),如“100㎡”而不是“100m2”。
- 文本应使用中文全角的货币符号(¥、$等)作为货币的表示,而不是英文半角的货币符号(¥、$等),如“1000¥”而不是“1000¥”。
- 文本应使用中文全角的省略号(……)作为省略或停顿的表示,而不是英文半角的省略号(...),如“这样……”而不是“这样...”。
- 文本应使用中文全角的破折号(——)作为转折或补充的表示,而不是英文半角的破折号(--),如“这样——”而不是“这样--”。
- 文本应使用中文全角的感叹号(!)作为感叹或强调的表示,而不是英文半角的感叹号(!),如“这样!”而不是“这样!”。
- 文本应使用中文全角的问号(?)作为疑问或反问的表示,而不是英文半角的问号(?),如“这样?”而不是“这样?”。
## 段落
段落是文本的基本组织单位,它可以将文本的内容分隔成逻辑上相对独立的部分,增加文本的层次感和可读性。段落的编写应遵循以下原则:
- 段落应使用空行(\n\n)作为段落之间的分隔,而不是使用空格( )或其他符号,如“*”、“-”等。
- 段落应使用缩进( )作为段落的开头,而不是使用空格( )或其他符号,如“*”、“-”等。
- 段落应使用一致的缩进长度,通常为两个或四个中文全角的空格( )、( ),而不是使用不同的缩进长度,如“ ”、“ ”等。
- 段落应使用一致的行宽,通常为每行不超过80个字符,而不是使用不同的行宽,如每行超过100个字符或不足50个字符等。
- 段落应使用一致的对齐方式,通常为左对齐,而不是使用不同的对齐方式,如右对齐或居中对齐等。
- 段落应使用一致的字体,通常为宋体或黑体,而不是使用不同的字体,如楷体或仿宋等。
- 段落应使用一致的字号,通常为12号或14号,而不是使用不同的字号,如10号或16号等。
- 段落应使用一致的颜色,通常为黑色或深灰色,而不是使用不同的颜色,如红色或蓝色等。
## 引用
引用是文档的常用手段之一,它可以引用其他文档或资料的内容,支持或补充文档的观点或论述,增加文档的权威性和可信度。引用的编写应遵循以下原则:
- 引用应使用中文全角的引号(“”)作为引用的标志,而不是使用英文半角的引号("")或其他符号,如“*”、“_”等。
- 引用应使用中文全角的冒号(:)作为引用的前缀,而不是使用英
中文文档编写规范(转载)
中文文档是指使用中文作为主要语言的文本文件,通常用于记录、传达或展示某种信息或知识。中文文档的编写需要遵循一定的规范,以保证文档的清晰、准确、规范和易读。本文是转载自 GitHub 的一篇文章,总结了一些中文文档的写作规范,涉及标题、文本、段落、引用、数值、标点符号等方面的注意事项。希望对中文文档的编写者有所帮助。
## 标题
标题是文档的重要组成部分,它可以概括文档的主题和内容,吸引读者的注意力,引导读者阅读。标题的编写应遵循以下原则:
- 标题应简洁明了,能够反映文档的核心内容,避免使用冗长、模糊或无关的词语。
- 标题应使用中文,除非是专有名词或无法翻译的词语,如“GitHub”、“Python”等。
- 标题应使用正确的语法和标点符号,遵循中文的语序和习惯,避免使用英文的语法和标点符号,如“?”、“!”等。
- 标题应使用一级标题(#)作为文档的主标题,使用二级标题(##)或更低级别的标题(###、####等)作为文档的子标题,标题的层级应递进且不跳跃,如不应使用“#”后直接使用“###”。
- 标题应使用中文全角的冒号(:)作为标题的后缀,而不是英文半角的冒号(:),如“标题:”而不是“标题:”。
## 文本
文本是文档的主体部分,它可以表达文档的详细内容,传递信息或知识,引发思考或讨论。文本的编写应遵循以下原则:
- 文本应使用中文,除非是专有名词或无法翻译的词语,如“GitHub”、“Python”等。
- 文本应使用正确的语法和标点符号,遵循中文的语序和习惯,避免使用英文的语法和标点符号,如“?”、“!”等。
- 文本应使用中文全角的标点符号,如“,”、“。”、“()”等,而不是英文半角的标点符号,如“,”、“.”、“()”等。
- 文本应使用中文全角的引号(“”)作为引用或强调的标志,而不是英文半角的引号("")或其他符号,如“*”、“_”等。
- 文本应使用中文全角的空格( )作为词语之间的间隔,而不是英文半角的空格( ),如“中文 文档”而不是“中文文档”。
- 文本应使用中文全角的数字(0、1、2等)作为数值的表示,而不是英文半角的数字(0、1、2等),如“300”而不是“300”。
- 文本应使用中文全角的百分号(%)作为百分比的表示,而不是英文半角的百分号(%),如“50%”而不是“50%”。
- 文本应使用中文全角的单位符号(㎡、℃等)作为单位的表示,而不是英文半角的单位符号(m2、C等),如“100㎡”而不是“100m2”。
- 文本应使用中文全角的货币符号(¥、$等)作为货币的表示,而不是英文半角的货币符号(¥、$等),如“1000¥”而不是“1000¥”。
- 文本应使用中文全角的省略号(……)作为省略或停顿的表示,而不是英文半角的省略号(...),如“这样……”而不是“这样...”。
- 文本应使用中文全角的破折号(——)作为转折或补充的表示,而不是英文半角的破折号(--),如“这样——”而不是“这样--”。
- 文本应使用中文全角的感叹号(!)作为感叹或强调的表示,而不是英文半角的感叹号(!),如“这样!”而不是“这样!”。
- 文本应使用中文全角的问号(?)作为疑问或反问的表示,而不是英文半角的问号(?),如“这样?”而不是“这样?”。
## 段落
段落是文本的基本组织单位,它可以将文本的内容分隔成逻辑上相对独立的部分,增加文本的层次感和可读性。段落的编写应遵循以下原则:
- 段落应使用空行(\n\n)作为段落之间的分隔,而不是使用空格( )或其他符号,如“*”、“-”等。
- 段落应使用缩进( )作为段落的开头,而不是使用空格( )或其他符号,如“*”、“-”等。
- 段落应使用一致的缩进长度,通常为两个或四个中文全角的空格( )、( ),而不是使用不同的缩进长度,如“ ”、“ ”等。
- 段落应使用一致的行宽,通常为每行不超过80个字符,而不是使用不同的行宽,如每行超过100个字符或不足50个字符等。
- 段落应使用一致的对齐方式,通常为左对齐,而不是使用不同的对齐方式,如右对齐或居中对齐等。
- 段落应使用一致的字体,通常为宋体或黑体,而不是使用不同的字体,如楷体或仿宋等。
- 段落应使用一致的字号,通常为12号或14号,而不是使用不同的字号,如10号或16号等。
- 段落应使用一致的颜色,通常为黑色或深灰色,而不是使用不同的颜色,如红色或蓝色等。
## 引用
引用是文档的常用手段之一,它可以引用其他文档或资料的内容,支持或补充文档的观点或论述,增加文档的权威性和可信度。引用的编写应遵循以下原则:
- 引用应使用中文全角的引号(“”)作为引用的标志,而不是使用英文半角的引号("")或其他符号,如“*”、“_”等。
- 引用应使用中文全角的冒号(:)作为引用的前缀,而不是使用英
版权声明:本文来源于互联网,不代表本站立场与观点,临夏教育无任何盈利行为和商业用途,如有错误或侵犯利益请联系我们。