文档写作规范指南
感谢
本文档写作规范指南基于 Nitwikit 项目的规范指南，感谢 Nitwikit 项目的贡献者。
一、标题规范
层级结构
- 一级标题：文章标题
- 二级标题：主要部分大标题
- 三级标题：二级标题下的小标题
- 四级标题：尽量避免使用，保持层级简单
使用原则
- 一级标题下不能直接出现三级标题
- 避免孤立编号（同级标题只有一个）
- 下级标题不重复上一级标题的名字
- 谨慎使用四级标题，可用项目列表代替
二、段落规范
基本原则
- 一个段落只有一个主题或中心句子
- 中心句子放在段首，对全段内容进行概述
- 段落长度不超过七行，最佳长度≤四行
- 使用陈述和肯定语气，避免感叹语气
- 段落之间用一个空行隔开
- 段落开头不留空白字符
引用规范
- 引用第三方内容时注明出处
- 全文转载需在开头显著位置注明作者和出处
- 使用外部图片必须在图片下方或文末标明来源
三、文本规范
字间距
- 全角中文字符与半角英文字符之间应有半角空格
- 全角中文字符与半角阿拉伯数字之间空格风格统一
- 英文单位前的阿拉伯数字与单位符号之间留适当空隙
- 半角字符与全角标点符号之间不留空格
句子规范
- 避免使用长句（20字以内最佳，不超过40字）
- 尽量使用简单句和并列句，避免复合句
- 使用肯定句表达，不使用否定句
- 避免使用双重否定句
写作风格
- 使用主动语态，避免被动语态
- 使用正式语言风格，避免非正式表达
- 使用现代汉语常用表达，避免冷僻、生造或文言文词语
- 正确使用"的"、"地"、"得"
- 代词指代明确，保证只有一个含义
- 名词前避免使用过多形容词
英文处理
- 英文复数形式翻译成中文时还原为单数
- 外文缩写可使用半角圆点表示
- 英文省略号改为中文省略号
- 第一次出现英文词汇时，在括号中给出中文标注
- 专有名词每个词首字母大写，非专有名词不需要大写
专有名词使用
- 使用正确的大小写（如GitHub）
- 不使用不地道的缩写（如使用JavaScript而非Js）
四、标点符号规范
基本原则
- 中文语句使用全角符号
- 整句为英文时使用英文/半角标点
- 句号、问号、叹号、逗号等不得出现在一行之首
- 点号不得出现在标题末尾，标号可以
常用标点
- 句号：中文语句结尾用全角句号（。）
- 逗号：表示句子内部一般性停顿，避免"一逗到底"
- 顿号：句子内部并列词用全角顿号（、）
- 分号：表示复句内部并列分句之间的停顿
- 引号：使用全角双引号（" "），内层用单引号（' '）
- 括号：使用全角圆括号（（）），前后不加空格
- 冒号：解释说明用全角冒号（：），时间用半角冒号（:）
- 省略号：使用中文省略号（⋯⋯），占两个汉字空间
- 感叹号：尽量避免使用，不得多个连用
- 破折号：占两个汉字位置，用于进一步解释
- 连接号：名词复合用直线连接号（-），数值范围用波浪连接号（～）
五、数值规范
基本规则
- 阿拉伯数字一律使用半角形式
- 千位以上数值添加千分号（半角逗号）
- 货币应在数字前写出货币符号，或在数字后写出货币中文名称
- 数值范围用波浪线（～）或一字线（—）连接
变化程度表示
- 增加：使用"增加了"、"增加到"
- 减少：使用"降低了"、"降低到"
- 不使用"降低N倍"或"减少N倍"的表示法
六、空格规范
基本规则
- 链接之间增加空格
- 加粗、斜体、高亮文本前后加空格
- 每行结尾不要空格
- 不要有多余的空行
- 文件末尾空一行
- 标题前后各空一行
七、文档体系
文件名规范
- 文件名不得含有空格
- 建议只使用小写字母
- 多个单词之间使用半角连词线（-）分隔