RFC 文档命名规范 - 快速参考

标准格式

{章节号}-{slug}.md

核心规则

✅ 正确示例

• 1-introduction.md
• 3-1-device-authorization.md
• 10-security-considerations.md
• appendix-a-examples.md
• authors-addresses.md

❌ 错误示例

• 1.Introduction.md → 大写 + 点号
• 2.Protocol_Overview.md → 大写 + 下划线 + 点号
• 3_1_Device_Auth.md → 大写 + 下划线
• 10.Security.md → 大写 + 点号

命名规则

规则	说明	示例
全小写	所有字母必须小写	introduction ✅ Introduction ❌
连字符	使用 - 分隔	device-auth ✅ device_auth ❌
无点号	不使用点号分隔	3-1-overview ✅ 3.1.Overview ❌
无下划线	不使用下划线	security-considerations ✅ Security_Considerations ❌
无空格	不使用空格	protocol-overview ✅ protocol overview ❌

特殊文件

附录

appendix-{字母}-{slug}.md

示例: appendix-a-examples.md, appendix-b-implementation-notes.md

索引

index.md

用途: RFC 概览页面

标准文件

authors-addresses.md
acknowledgements.md
acknowledgments.md
references.md
normative-references.md
informative-references.md
iana-considerations.md
security-considerations.md

快速工具

验证文件名

npm run validate:naming

查看详细报告

npm run validate:naming:report

自动修复

npm run validate:naming:fix

预览批量重命名

npm run rename:preview

执行批量重命名

npm run rename:apply

多级章节

一级章节: 1-introduction.md
二级章节: 3-1-device-authorization.md
三级章节: 8-2-1-neighbors-and-parents.md
四级章节: 4-3-2-1-specific-subsection.md

规则: 使用 - 连接所有层级数字

Slug 生成示例

原始标题	Slug
Introduction	introduction
Protocol Overview	protocol-overview
Device Authorization Flow	device-authorization-flow
Security Considerations	security-considerations
IANA Considerations	iana-considerations
Authors' Addresses	authors-addresses
HTTP/2 Frame Format	http2-frame-format
BGP-4 Protocol	bgp-4-protocol

跨语言一致性

重要: 所有语言版本使用相同的文件名，仅内容翻译

✅ 正确:
docs/rfc-9113/1-introduction.md             # 英文
i18n/de/docusaurus-plugin-content-docs/current/rfc-9113/1-introduction.md  # 德文
i18n/zh/docusaurus-plugin-content-docs/current/rfc-9113/1-introduction.md  # 中文

❌ 错误:
docs/rfc-9113/1-introduction.md             # 英文
i18n/zh/docusaurus-plugin-content-docs/current/rfc-9113/1-简介.md  # 翻译了文件名

PR 检查清单

• 文件名全小写
• 使用连字符分隔
• 无下划线、点号、空格
• 跨语言文件名一致
• 本地验证通过

更多信息

📖 完整命名规范
🛠️ 工具使用指南
📊 实施报告