名称命名
文件命名
本节以 Markdown 语言编写的技术文档为例,介绍源文件的命名规范。如下所示。
- 文件名应该能对文档内容进行简要概括。
- 文件名不宜过长。
- 当文件名由多个英文单词组成时,单词中间应当由短划线“-”隔开。
- 不建议在文件名中使用下划线“_”。在 URL 中出现下划线不利于搜索引擎优化,且下划线在部分 Markdown 实现中是修饰字符。
- 当文件名由多个英文单词组成时,文件名建议使用全小写单词,全大写亦可接受,如 FAQ.md。
- 文件名禁止大小写混用。
- 文件后缀名应当使用小写形式。
- Markdown 文件应当使用“.md”后缀,“.markdown”亦可接受,但要保证风格统一。
产品命名
一个公司命名其产品(或周边工具)时应遵循一定的风格规范,不可随意取名。否则,重则有法律风险(重名问题),轻则影响对外品牌输出。
建议在全公司范围内,建立产品命名的统一流程,维护一份统一的产品名称表。
名称使用
中文技术文档中使用一些专用名称时,应注意如下规范。
国外公司、品牌或产品名称使用规范
中文文档中指称国外公司、品牌或产品名称时,建议遵循以下规范:
- 对于中文读者熟知其中文官方译名的公司、品牌或产品名称,只需用中文官方译名指称
- 对于中文读者不熟悉、但有中文官方译名的公司、品牌或产品名称,建议用“中文官方译名 (英文官方名称)”形式
- 对于无中文官方译名的公司、品牌或产品名称,建议直接用英文指称,且必须使用正确的大小写形式
- 【错误示例】mysql、github、tiktok、wechat
- 【正确示例】MySQL、GitHub、TikTok、WeChat
注意事项:
- 判断中文大众读者是否熟知某名称具有主观性。如果不确定中文读者是否熟知某名称,建议优先考虑“中文官方译名 (英文官方名称)”形式。
- 在使用“中文官方译名 (英文官方名称)”形式时,只需在第一次出现该名称的时候使用完整形式,之后再出现时使用中文官方译名即可。
公司、品牌或产品名称列表
下表仅提供参考示例,不同公司可视自身内容情况作相应的调整。
下表待补充,欢迎贡献!
中文读者熟知中文官方译名 | 中文读者不熟悉、但有中文官方译名 | 无中文官方译名 |
---|---|---|
微软 | 威睿 (VMware) | GitHub |
苹果 | 塔多思 (Trados) | SDL |
甲骨文 | 雪佛龙 (Chevron) | MySQL |
沃尔玛 | 埃克森美孚 (Exxon Mobil) | Alphabet |
亚马逊 | 大众 (Volkswagen) | MongoDB |
惠普 | 戴姆勒 (Daimler) | Azure |
宝马 | 西门子 (Siemens) | |
波音 | 软银 (SoftBank) | |
雀巢 | 东芝 (Toshiba) | |
宝洁 | 思科 (Cisco) | |
强生 | ||
索尼 | ||
百事 | ||
可口可乐 | ||
高盛 | ||
佳能 | ||
推特 | ||
脸书 | ||
领英 |