RFC 文档规范

1. 概述

请求意见稿（英语：Request for Comments，缩写：RFC），又翻译作意见征求，意见请求，请求评论是由互联网工程任务组（IETF）发布的一系列备忘录。文件收集了有关互联网相关信息，以及 UNIX 和互联网社群的软件文件，以编号排定。目前 RFC 文件是由互联网协会（ISOC）赞助发行，最终演变为用来记录互联网规范、协议、过程等的标准文件。

RFC 作为文档前缀有井井有条、正式的去编写文档的意思，我们使用 RFC 文档主要用来编写技术文档，记录重要事务。

2. 文档规范

2.1. 目录规范

• 结构清晰、目录深度均衡
• 简洁优雅、易于阅读
• 可使用 Confluence 自带的目录
• 标题简短准确

2.2. 排版

• 英文专有名词首字母需大写、中文标点符号使用全角符号
• 段落末尾没必要不加标点符号
• 插图、代码块、表格等大小设置适中，统一不进行缩进
• 整体色调统一和谐
• 保持排版紧凑，删除空行

2.3. 内容

• 中文与英文、中文与数字之间保留一个空格（例如”以及 UNIX 和互联网“ 前后保留空格）
• 表达性（表述准确、逻辑清晰、用词准确，避免概念模糊、产生歧义）
• 一致性（命名保持一致：同样的概念，在不同文档、代码里使用同一个名称；同样的单词保持一致：例如在同一份文档里，不能同时出现 “APP”、“App”、“app”）

2.4. 插图

在涉及视图操作时，应该合理利用截图来提高易读性，常言一图胜千言。制作截图时，遵循以下：

• 插图要释义，避免图不对题
• 插图要干净，避免水印
• 尺寸合理，文档整体预览和谐统一

2.5. 代码块

• 只保留关键代码，步骤清晰
• 代码注释符合注释规范
• 篇幅较长的代码里，请多使用代码注释，使用 “…” 省略无关代码

2.6. 参考和引用

• 声明引用文章的链接，尊重内容原作者
• 提供给读者深入学习的链接

2.7. 编辑权限

• 原则上第一作者或者共同作者才有编辑权限

3. 参考文档

原文链接

维基百科 RFC