技术名词大小写规范全解析:从JSON到GitHub的正确写法
1. 项目概述为什么技术名词大小写是个“大”问题干了这么多年技术从写代码、写文档到做分享、做评审我踩过最隐蔽、最让人哭笑不得的坑往往不是高深的算法bug而是那些看起来“无伤大雅”的技术名词大小写。你有没有遇到过这种情况团队新来的小伙伴提交了一段代码功能完全正确但评审时你一眼就看到他把JavaScript写成了Javascript或者把GitHub写成了Github。更常见的是在文档里JSON、RESTful API、Node.js这些词的大小写五花八门看得人强迫症都要犯了。这绝不仅仅是“强迫症”或者“洁癖”那么简单。技术名词的大小写是专业性的最直接体现是代码与文档可读性、可维护性的基石甚至在某些场景下直接关系到功能能否正确运行。一个正确的大小写意味着你对这项技术有基本的尊重和了解而一个错误的大小写轻则让同行觉得你不专业重则可能导致工具链识别错误、依赖安装失败、API调用异常。这个项目就是把我这些年积累的、见过的、以及从无数官方文档和社区规范中梳理出来的技术名词大小写规范进行一次系统性的整理和分享。它不是一份死板的规则列表而是一套结合了“为什么”要这么写以及“如何”在不同场景下正确应用的实战指南。我会持续更新也欢迎大家一起来查漏补缺让我们写出的每一个技术名词都经得起推敲。2. 核心规范原则与常见误区解析在开始罗列具体名词之前我们必须先理解技术名词大小写背后的一些通用原则和常见思维误区。掌握了这些你就能举一反三即使遇到一个从未见过的新名词也能做出相对合理的判断。2.1 四大核心规范原则技术名词的大小写并非随心所欲通常遵循以下几种模式理解其成因是关键1. 驼峰命名法衍生这是最常见的原则之一尤其适用于由多个单词组合而成的技术名词。大驼峰每个单词的首字母大写其余字母小写。这通常用于品牌名、产品名或强调其作为一个整体专有名词。例如JavaScript(由 Java 和 Script 组成)、PowerPoint、TypeScript。小驼峰第一个单词首字母小写后续单词首字母大写。这在技术名词作为变量名、属性名时常见但其原始品牌名仍可能采用大驼峰。例如ajax(源自AJAX)但在代码中我们常写ajaxRequest。2. 首字母缩写全大写对于广为人知的首字母缩写通常全部大写。这能清晰表明它是一个缩写而非一个普通单词。标准缩写API(Application Programming Interface),URL(Uniform Resource Locator),HTML(HyperText Markup Language),SQL(Structured Query Language)。注意点当这些缩写词出现在句首时依然保持全大写不要改为仅首字母大写。例如“API 设计至关重要”而不是 “Api 设计至关重要”。3. 特定品牌或公司命名规则许多技术名词是公司的注册商标或特定品牌其大小写规则由所有者规定必须严格遵守这是法律和品牌一致性的要求。大小写混合如GitHub(G和H大写)、npm(全小写但作为命令和公司名时)、iOS(i小写OS大写)、macOS(m小写ac小写OS大写)。全小写如docker、kubernetes(常简写为 k8s)但在句首时品牌名仍保持全小写或考虑重写句子避免开头。例如“docker 容器非常轻量”虽然看起来别扭但比写成 “Docker 容器” 更符合官方规范。4. 保留特定字符一些技术名词包含点号.、连字符-、数字等这些字符是其固定组成部分不能省略或更改。点号Node.js(点号前后无空格)、.NET(作为品牌点号开头)。连字符/减号ASP.NET Core(中间有空格和点号)、e-commerce(但作为技术平台如Shopify是品牌名)。数字Python 3(3是版本号与Python有空格)、C、C#(数字和符号是名称一部分)。2.2 五大常见误区与“想当然”陷阱很多错误源于我们根据英语语法或日常习惯进行的“合理”推测但在技术领域却行不通。误区一在句首“纠正”大小写。这是最普遍的误区。我们写英文句子时习惯将句首单词首字母大写。但当这个单词是一个有固定大小写规则的技术名词时就不能这么改。错误示例“Json 是一种轻量级数据格式。” (句首的Json)正确示例“JSON 是一种轻量级数据格式。” (保持JSON全大写)更优处理如果觉得以全大写缩写开头不美观可以重构句子。例如“我们通常使用 JSON 这种轻量级数据格式。”误区二将缩写当作普通单词进行复数或所有格变化。直接在全大写缩写后加s或s看起来很不协调通常需要调整表达方式。不推荐“多个 APIs 的设计风格”、“JSON’s 的语法”推荐表达“多个 API 端点的设计风格”、“JSON 的语法规则” 或 “JSON 语法”误区三混淆大小写和全称。大小写是书写形式全称是完整名称。不要因为写了全称就随意改变其缩写的大小写规则。错误“我们需要调用一个 Application Programming Interface (Api)。”正确“我们需要调用一个 Application Programming Interface (API)。”误区四忽略版本号和环境的特定写法。版本号和环境标识符有约定俗成的写法。错误“python3”、“node-js”、“react js”正确“Python 3”有空格、“Node.js”有点号、“React.js” 或通常直接写 “React”。误区五凭记忆或感觉书写不查证。这是万恶之源。技术发展快新名词层出不穷很多名词的大小写反直觉如JavaScript中的S大写。最可靠的方法是对于不确定的名词第一时间查阅其官方网站、官方文档或维基百科页面。官方文档的标题、LOGO 和正文首现处就是最权威的书写规范。实操心得我养成的一个习惯是在团队的共享文档或代码库的README中维护一个“技术名词书写规范”的速查表。每当有新成员加入或遇到有争议的名词就更新进去。这不仅能统一团队输出也是一个很好的知识沉淀。3. 分类详解常见技术名词大小写规范速查下面我将分门别类列出常见技术名词的正确写法并附上简要说明和易错点。你可以把这里当作一个速查字典。3.1 编程语言与运行时这类名词的大小写规则较为多样品牌效应强。正确写法错误写法示例说明与备注JavaScriptJavascript, Java-Script商标S必须大写。是 ECMAScript 的实现之一。TypeScriptTypescript, Type-ScriptS必须大写遵循与 JavaScript 类似的品牌逻辑。Pythonpython首字母大写源自巨蟒 Monty Python是专有名词。Javajava首字母大写品牌名。CC, cC大写是运算符的一部分整体无空格。C#C#, c#C大写#读作 “Sharp”是名称一部分。PHPPhp, php传统上全大写是 “PHP: Hypertext Preprocessor” 的递归缩写。Gogo, Golang语言名称为Go但因其通用性社区常用Golang指代以便搜索。在正式文档中应使用 Go。Rustrust首字母大写。Kotlinkotlin首字母大写。Swiftswift首字母大写。Node.jsNodejs, node.js, nodeJS官方品牌N大写.后js全小写。常简称为 “Node”。3.2 平台、框架与库这类名词通常有强烈的品牌标识需严格遵循官方写法。正确写法错误写法示例说明与备注ReactReact.js, REACT官方品牌为React。虽然常与.js联用但单独提及时应使用 React。其生态中的React Native的N也大写。Vue.jsVue, VueJS, vue.js官方品牌包含.js应写全。但在非正式场合Vue也被广泛接受。AngularAngularJSAngular特指 2.0 及以后版本。AngularJS特指 1.x 版本两者不同不可混用。.NET.Net, dotNet品牌以点号开头N和T大写。读作 “dot net”。ASP.NET CoreAsp.Net Core, ASP.net coreASP全大写.连接NET全大写空格后Core首字母大写。Spring BootSpring boot, spring-bootSpring和Boot首字母均大写中间有空格。Djangodjango首字母大写。Ruby on RailsRuby On Rails, ruby on railsRuby和Rails首字母大写on小写。常简称为Rails。TensorFlowTensorflow, tensor flowT和F大写中间无空格。PyTorchPytorch, pytorchP和T大写。3.3 协议、格式与数据交换这类名词多为缩写通常全大写但也有一些特例。正确写法错误写法示例说明与备注HTTPHttp, http超文本传输协议全大写。HTTPSHttps, httpsHTTP Secure全大写。WebSocketWebsocket, Web Socket作为一个专有名词W和S大写。RESTRest, rest表征状态转移全大写。其衍生概念RESTful的R大写ful小写。GraphQLGraphql, GraphQlG,QL大写QL是 Query Language 的缩写。JSONJson, jsonJavaScript Object Notation全大写。这是最高频的错误之一XMLXml, xml可扩展标记语言全大写。YAMLYaml, yaml全大写。有趣的是它递归地表示 “YAML Ain‘t Markup Language”。CSVCsv, csv逗号分隔值全大写。SQLSql, sql结构化查询语言全大写。但其具体实现如MySQL,PostgreSQL有特定大小写。3.4 工具、平台与服务品牌规则在这里占主导很多写法反直觉。正确写法错误写法示例说明与备注Gitgit版本控制系统官方表示名称可大小写但通常句首外全小写git指命令首字母大写Git指系统或品牌。为清晰起见建议系统/品牌用Git。GitHubGithub, GITHUBH必须大写这是公司规定的品牌写法。GitLabGitlab, gitlabL必须大写。npmNPM, Npm包管理器官方规定全小写。但作为公司被 GitHub 收购时也使用全小写。yarnYarn, YARN包管理器官方规定全小写。Dockerdocker容器平台首字母大写。但docker命令全小写。Kuberneteskubernetes首字母大写。缩写k8s全小写。VS CodeVSCode, vscodeVisual Studio Code 的简称。官方写法是VS CodeVS大写且与Code间有空格。虽然VSCode也常见但遵循官方更佳。Postmanpostman首字母大写。Jirajira, JIRA首字母大写。虽然其项目键通常全大写如PROJ-1但产品名是Jira。3.5 操作系统与平台正确写法错误写法示例说明与备注Linuxlinux内核及广义操作系统首字母大写。但linux命令全小写。Windowswindows首字母大写。macOSMacOS, Mac Os, OS X当前苹果桌面操作系统。m小写ac小写OS大写。旧版本OS X的写法也已过时。iOSIOS, Ios苹果移动操作系统。i小写OS大写。Androidandroid首字母大写。Ubuntuubuntu首字母大写源自非洲哲学概念。CentOSCentos, CENTOSC、OS大写中间小写。现已停止更新。Debiandebian首字母大写。4. 不同场景下的应用实践与工具辅助知道了规则更要知道如何在代码、文档、沟通等不同场景中正确应用。不同的场景侧重点和约束也不同。4.1 代码中的大小写规范在代码中技术名词通常以两种形式出现作为语言关键字/内置对象和作为我们标识符的一部分。1. 语言关键字与内置对象严格遵循该语言社区的约定。例如JavaScript:JSON,XMLHttpRequest,Set,Map等内置构造函数或对象通常首字母大写或全大写。Python:内置函数如json.loads()模块名全小写但类名如datetime.datetime采用大驼峰。Java:所有类名大驼峰常量全大写加下划线如MAX_CONNECTIONS。2. 自定义标识符中的技术名词当技术名词成为你变量、函数、类名的一部分时应遵循项目本身的命名规范如驼峰或蛇形同时尽量保留技术名词的可识别性。示例你需要一个变量存储 GitHub 的 API 响应。蛇形命名项目github_api_response小驼峰命名项目githubApiResponse关键点虽然GitHub品牌要求H大写但在变量名中为了符合项目整体风格我们可能将其转换为全小写 (github) 或仅首字母小写 (github)。此时在注释或文档中说明其代表GitHub即可。一致性优先于绝对的原样保留。4.2 文档与文章中的大小写规范这里是规范体现最全面的地方也是错误的高发区。1. 标题与正文在标题中技术名词应保持其正确形式即使它位于标题开头。例如“JSON数据解析最佳实践”而不是 “Json数据解析最佳实践”。在正文句首处理方法前文已述优先保持原样其次考虑改写句子。2. 超链接与强调在 Markdown 或富文本中为技术名词添加链接时链接文本也应使用正确的大小写。[JavaScript 教程](https://example.com)是正确的。使用加粗或斜体强调时同样不要改变其大小写。3. 列表与表格在清单或表格中罗列技术栈时确保每一项的书写都符合规范这能让列表显得非常专业。4.3 沟通与演示中的注意事项在 Slack、Teams、邮件甚至面对面交流中虽然口语化更强但书面提及技术名词时仍应尽量规范。即时通讯在技术频道讨论时使用正确的大小写能减少歧义。比如问“这个 api 怎么调”就不如“这个API怎么调”清晰。演示文稿PPT 或 Keynote 的标题、要点和代码片段中必须严格遵循大小写规范。这是专业度的直观展示。4.4 自动化检查与辅助工具人工记忆总有疏漏借助工具可以极大提升效率和准确性。1. 代码检查工具ESLint (JavaScript/TypeScript):可以使用如eslint-plugin-capitalized-comments等插件来检查注释中技术名词的大小写。markdownlint:用于检查 Markdown 文档虽然不直接检查技术名词但能保证文档结构清晰间接提醒你注意书写。自定义词典在 IDE如 VS Code中将常见技术名词如JavaScript,GitHub,Node.js添加到用户词典可以避免拼写检查器将其标红并能在你输入错误时提示正确写法。2. 文档与写作辅助术语统一工具一些高级文档平台或团队知识库系统支持定义“术语表”并能在全站范围内进行一致性检查和替换建议。文本扩展工具使用 Alfred、TextExpander 等工具为常输错的技术名词设置缩写。例如输入;js自动扩展为JavaScript输入;gh扩展为GitHub。实操心得我在团队内部推动了一项简单的 Code Review 检查项“关注文档和注释中的技术名词大小写”。起初有人觉得繁琐但坚持几周后大家普遍反馈代码库的文档看起来“清爽”、“专业”了很多。这种潜移默化的影响对团队工程文化素养的提升是实实在在的。5. 疑难案例与动态名词处理技术领域日新月异总有一些名词的写法存在争议、正在演变或是容易混淆。处理这些情况需要一些策略和判断。5.1 存在争议或演变中的名词AI / ai / Ai / Artificial Intelligence:作为“人工智能”的缩写目前主流媒体和学术出版物倾向于全大写AI。但在一些科技公司的行文或产品描述中也常见小写ai作为前缀或修饰如ai model。建议在正式技术文档中使用全大写AI。在非正式或产品营销语境中可酌情参考具体公司的用法。Web3 / web3:指下一代去中心化互联网。目前两种写法并存但Web3W大写3为数字似乎更常见将其视为一个专有名词。建议在文章中首次出现时可以注明“通常写作 Web3”之后保持一致即可。vs / vs. / VS:表示“对比”。在技术博客标题或正文中为保持简洁常用vs如 “React vs. Vue”。在更正式的场合或品牌中如VS Code则用大写VS。建议技术文档中用小写vs或vs.均可但需全文统一。5.2 容易混淆的“孪生”名词有些名词极其相似但大小写不同含义天差地别。MongoDB vs mongoDB:MongoDB是数据库公司的品牌和产品名M和DB大写。而mongodb全小写通常指驱动、命令行工具或非特指时的写法。在句子中应使用MongoDB。MySQL vs MySql vs mysql:数据库名。正确写法是MySQL。My和SQL都大写。mysql全小写通常指客户端命令。iPhone vs IPHONE:苹果手机品牌。官方写法是iPhonei小写P大写。全大写IPHONE仅在特殊设计或旧式系统中出现不应在正式文本中使用。iPad, iMac, iOS:同理苹果产品线前缀i均小写后面单词首字母大写。5.3 如何处理不确定的新名词面对一个全新的技术名词例如一个刚刚开源的项目如何确定其大小写黄金法则查阅官方信源。访问其官方网站、GitHub 仓库首页、官方发布的博文或公告。看其 LOGO 如何设计看其文档标题如何书写。观察社区主流用法。在 Stack Overflow、Reddit 的相关板块或技术新闻网站中观察资深开发者是如何书写它的。社区共识有时在官方未明确时起指导作用。分析其命名逻辑。它是缩写吗如REST是组合词吗如TypeScript仿JavaScript是品牌吗通常有特定大小写根据第 2 章的原则进行合理推测。在团队内部约定。如果经过以上步骤仍无法确定或者两种写法并存团队内部可以讨论并约定一种写法并在项目文档中记录下来确保内部一致性。这比混用要好得多。6. 建立团队规范与持续维护个人的习惯养成固然重要但在团队协作中将技术名词书写规范制度化能带来更大的收益。6.1 创建团队技术名词词典建议创建一个简单的 Markdown 文件如STYLE_GUIDE-TERMS.md放在团队知识库或代码仓库的根目录。内容可以按照本文的分类列出团队常用技术栈的名词规范。# 团队技术名词书写规范 ## 编程语言 - JavaScript (勿用 Javascript) - TypeScript (勿用 Typescript) - Python 3 (勿用 python3) - Node.js (勿用 nodejs) ## 框架与库 - React (正式名称非 React.js) - Vue.js (需包含 .js) - Spring Boot (Boot 大写) ## 服务与工具 - GitHub (H 大写) - Docker (首字母大写) - npm (全小写) - VS Code (V S 空格 Code) ## 协议与格式 - JSON (全大写) - API (全大写) - RESTful (R 大写)这个文件应该作为新成员入职必读文档之一。6.2 将规范集成到开发流程Code Review 环节在 Pull Request 的审查清单中加入一项“检查文档、注释及变量名中的技术名词书写是否规范”。这不需要耗费主要精力只需一眼扫过即可但能形成有效的监督。文档模板为技术设计文档、API 文档、README 创建模板在模板的显著位置加入书写规范的提示或链接。IDE 共享配置如果团队使用相同的 IDE可以共享代码片段或用户词典配置让自动补全和拼写检查更“聪明”。6.3 文化的培养从细节追求卓越统一技术名词的书写看似是细枝末节实则反映了团队对细节的态度、对专业的追求以及对协作成果的尊重。一个连名词书写都混乱的文档很难让人相信其背后的代码是严谨可靠的。反之一个处处规范、精致的代码库和文档集能极大提升团队的内聚力和外部声誉。作为技术负责人或资深成员以身作则至关重要。在每一次代码提交、每一份文档撰写、每一次技术分享中都严格遵守并温和地提醒他人注意这些规范。久而久之这就会成为团队 DNA 的一部分。最后这份列表是活的。技术生态在变化新的名词会涌现旧的写法也可能调整例如Mac OS X到OS X再到macOS。我会持续关注和更新这篇文章也希望大家能在评论区分享你们遇到的疑难杂症或者“血泪教训”。让我们共同维护这份追求精确与专业的“执念”因为好的工程实践正是由这无数个细微之处的坚持所构筑的。