文件命名
在以 Markdown 语言编写的技术文档中,源文件的命名应遵循以下规范:
- 文件名应简明地概述文档内容。
- 文件名长度应适中,避免过长。
- 当文件名由多个英文单词组成时,用短划线「-」连接。
- 在文件名中避免使用下划线「_」,它在 URL 中可能影响搜索引擎优化,并可能被某些 Markdown 实现当作修饰字符。
- 多个单词组成的文件名,全小写或全大写均可,但避免大小写混用,如
faq.md
或FAQ.md
。 - 文件扩展名应为小写。
- Markdown 文件应使用「.md」后缀,虽然「.markdown」也可以接受,但应保证整体文件风格的统一。
文件名 | 内容描述 |
---|---|
introduction-to-python.md | 此文件可能包含有关 Python 语言的基础知识 |
database-connection-guide.md | 这是一个指南,说明如何连接到数据库 |
faq.md | 这是一个常见问题解答文件 |
README.md | 这是一个项目介绍文件 |
产品命名
企业为其产品或工具命名时,应确保遵循一致的风格和规范,以避免可能的法律风险(如重名问题)和品牌形象受损。推荐组织设立统一的产品命名流程,并维护一个组织内部产品名称列表。
英文产品名称 | 中文产品名称 |
---|---|
Microsoft Office | 微软办公软件 |
Photoshop | 阿多比 Photoshop |
名称使用
在中文技术文档中,应遵守以下专用名称使用规范:
国外组织、品牌或产品名称使用规范
- 当中文读者熟知其中文官方译名时,使用中文官方译名。
- 当中文读者不熟悉、但有中文官方译名时,使用「中文官方译名 (英文官方名称)」格式。
- 对于没有中文官方译名的名称,直接用英文指称,务必保持正确的大小写形式。
注意,判断是否「中文读者熟知」具有主观性,如有疑虑,建议优先使用「中文官方译名 (英文官方名称)」格式。在首次提到该名称时,使用完整格式,之后的提及可只使用中文官方译名。
组织、品牌或产品名称列表
中文读者熟知中文官方译名 | 中文读者不熟悉、但有中文官方译名 | 无中文官方译名 |
---|---|---|
微软 (Microsoft) | 威睿 (VMware) | GitHub |
苹果 (Apple) | 塔多思 (Trados) | SDL |
甲骨文 (Oracle) | 雪佛龙 (Chevron) | MySQL |
沃尔玛 (Walmart) | 埃克森美孚 (Exxon Mobil) | Alphabet |
亚马逊 (Amazon) | 大众 (Volkswagen) | MongoDB |
惠普 (HP) | 戴姆勒 (Daimler) | Azure |
宝马 (BMW) | 西门子 (Siemens) | Jira |
波音 (Boeing) | 软银 (SoftBank) | Slack |
雀巢 (Nestle) | 东芝 (Toshiba) | Docker |
宝洁 (Procter & Gamble) | 思科 (Cisco) | Kubernetes |
强生 (Johnson & Johnson) | 瑞声 (Resound) | Ansible |
索尼 (Sony) | 罗克韦尔 (Rockwell Automation) | GitLab |
百事 (Pepsi) | 三洋 (Sanyo) | TensorFlow |
可口可乐 (Coca-Cola) | 格雷普 (Crepe) | Elasticsearch |
高盛 (Goldman Sachs) | 微步 (Microstep) | PyTorch |
佳能 (Canon) | 三菱 (Mitsubishi) | Apache Kafka |
推特 (Twitter) | 亚都 (Audu) | Redis |
脸书 (Facebook) | 逸碧 (Epyc) | Apache Spark |
领英 (LinkedIn) | 萨博 (Saab) | Terraform |