GrowthBook 用户可见文案的大小写规范：两级 Casing 规则与命名资源词表

后端前端数据分析数据可视化【免费下载链接】growthbookOpen Source Feature Flags, Experimentation, and Product Analytics项目地址https://gitcode.com/gh_mirrors/gr/growthbook点击查看免费下载本文基于 GrowthBook 仓库中的 AI 规则文件.claude/rules/ui-copy-style.md及其指向的规范文档系统讲解 GrowthBook 对用户可见字符串前端标签、标题、按钮、占位符、正文以及后端返回给用户或 API 调用者的错误/校验消息所执行的大小写与措辞约定。读完本文你将掌握 GrowthBook 的两级 Casing 规则、完整的命名资源named resource词表、后端 API 消息的写法边界以及该规范如何通过 Claude Code / Cursor 规则文件在多包代码库中被强制执行。规则入口三份配置如何指向同一份规范GrowthBook 将文案规范拆成触发器和正文两层分别落在不同 AI 编码助手的规则目录中.claude/rules/ui-copy-style.mdClaude Code 规则通过paths前置元数据限定作用范围.cursor/rules/ui-copy-style.mdcCursor 规则通过globs限定作用范围且alwaysApply: false不全局强制仅在命中文件模式时加载.agents/guides/ui-copy-style.md规范的唯一正文single source of truth。.claude触发器的paths前置元数据限定了规则生效的代码范围恰好覆盖三个承载用户可见字符串的包paths: - packages/front-end/**/*.{ts,tsx} - packages/back-end/src/**/*.ts - packages/shared/src/**/*.ts触发器文件本身只有一句话在编写或编辑任何用户可见字符串之前必须先阅读并遵循.agents/guides/ui-copy-style.md。这种触发器定范围、指南定内容的结构可以避免同一份规范在多份配置中各写一遍而产生分歧——正文永远只维护在.agents/guides/下。两级 Casing 规则标题 Title Case其余 Sentence case规范正文给出的核心规则只有两级按元素类型选择Title Case首字母大写仅用于Heading元素即章节与子章节标题。例如 Data Source Settings、Experiment Health Settings。Sentence case仅句首大写用于其余一切元素——字段标签、复选框/开关标签、下拉框标签、按钮、占位符、tooltip、辅助说明文本和正文。只大写第一个词。例如 Require unique experiment keys、Add custom、New template。规范强调 sentence case 是动作与标签的默认风格这与现代产品惯例一致。按钮用 sentence case而不是 Title Case如 Save、Regenerate all、Import from another service。这一约定在仓库前端源码中可以直接验证。标题元素确实使用 Title CaseMetricsSettings.tsxHeading size4 ash4Metrics Settings/HeadingDatasourceSettings.tsx标题 Data Source SettingsEditDataSourceForm.tsx表单头headerEdit Data Source Settings。而同一个文件里的非标题元素则是 sentence case例如 MetricsSettings.tsx 中的字段标签 Metric analysis lookback window——只有首词 Metric 大写且 Metric 在此是句首analysis lookback window 全部小写正符合规则。后端与 API 错误消息的写法规范明确后端没有标题元素因此 Title Case for headings 这一档不适用于后端——错误消息、校验消息以及任何返回给用户或 API 调用者的字符串都属于正文body copy一律使用sentence case但命名资源仍按词表保持 Title Case。规范给出的四条正误对照示例判定原因throw new Error(Feature key must be unique within the Project);正确sentence caseProject 是命名资源保持 Title Casecontext.permissions.throwPermissionError(You do not have permission to modify this Saved Group);正确句首大写 命名资源 Saved Groupthrow new Error(Feature Key Must Be Unique);错误这不是标题不该用 Title Casethrow new Error(could not find data source);错误句首未大写且 Data Source 是命名资源应 Title Case规范还要求当消息本身是一个完整句子时写出完整、带标点的句子被插值的标识符id、key、字段名按原样保留因为它们是数据而非文案。仓库后端代码与该约定一致例如 saved-group.controller.tsthrow new Error(Must specify Saved Group id); ... throw new Error(Could not find Saved Group);以及 factTableTestQueries.tsthrow new Error(Sample rows are not supported on this Data Source);两者都是 sentence case 句首大写 命名资源Saved Group、Data Source保持 Title Case 的标准写法。命名资源词表覆盖两级规则的唯一例外规范中唯一凌驾于两级规则之上的例外是一等 GrowthBook 资源在任何位置包括正文中间、sentence case 标签内部都保持 Title Case。这些是用户在侧边栏看到、或能识别为数据模型的命名事物因此读起来像专有名词。规范给出的完整词表如下与.agents/guides/ui-copy-style.md中保持一致术语复数备注GrowthBook—产品名。绝不写作 Growthbook 或 growthbookVisual Editor—产品功能名North StarNorth Stars指标概念BanditBandits—Data SourceData Sources—Fact MetricFact Metrics只有指代 Fact Metric 资源时才大写普通语境下的 metric 用小写Feature FlagFeature Flags用户可见文案中必须用完整的 Feature Flag不得用 Feature 或 Flag 简写Saved GroupSaved Groups—SDK ConnectionSDK Connections—Experiment TemplateExperiment Templates完整复合词是命名资源单独的 template 仍是小写普通名词select a template、New templateExperiment Decision Framework—Title Case可缩写为 EDFMetric Slices—指标切片功能整体Auto SliceAuto Slices自动填充并管理 Metric SlicesAuto Slice levels 中的 levels 仍是小写普通名词ProjectProjects带独立侧边栏入口和页面的一等资源。All Projects 是表示所有 Project的固定作用域标签ConstantConstants带独立侧边栏入口和页面的一等资源ConfigConfigs一等资源。配置对象、配置文件或其他产品的 config 仍用小写由此推出的读法是sentence case 标签依然写作 Require approval to modify Saved Groups正文依然写作 users will only be able to create Fact Metrics。普通名词、技术标识符与灰区边界词表之外有三条细化规则决定了一个词到底该不该大写不在词表中的普通名词句中小写experiment、metric、dimension、segment、environment。只有词表中的术语被提升为专有名词。Product 系资源的同名借用要区分语境Project 指 GrowthBook 资源时到处 Title CaseSelect a Project、All Projects但属于其他产品的 projectBigQuery、GCP、Amplitude 的 project是该产品的普通名词保持小写per-project、project-level 这类连字符修饰语保持小写。All Environments 是固定作用域标签用 Title Case但单独的 environment/environments 仍小写。Config 与 Constant 有同样的注意项命名 GrowthBook 资源时 Title Case普通语义下小写——SDK config、config.yml文件或其他产品的 config 不是 Config不变的值也不是 Constant。技术标识符在正文中小写experiment key、experiment tracking key、API key、attribute、token。它们是技术概念而非命名资源遵循与 personal access token 相同的惯例——小写除非处于句首。此外规范承认一个灰区产品区域名。当 Experiments 这类词指代产品区域/功能本身、而非计数单个实验时Title Case 可以适用——按具体情况判断不确定时默认小写。规范明确这是未定论的问题不要批量套用文中给出的现行用例Enable fallback attributes in Experiments。词表维护与完整示例对照关于词表本身规范给出维护策略只有当术语指代用户管理的一等资源通常有独立侧边栏入口、model 或顶级页面时才新增条目不要为普通名词或 UI 概念加条目拿不准就保持小写词表是单一事实来源引入新术语的改动必须在同一次变更中更新词表。规范最后给出一组可直接对照的示例覆盖标题、标签、按钮、正文、API 错误五类元素Heading: Metrics Settings (Title Case, it is a heading) Label: Require fact metrics wrong Label: Require Fact Metrics right, Fact Metric is a named resource Label: Minimum metric total right, metric here is a common noun Button: New Template wrong, buttons are sentence case Button: New template right, bare template is a common noun Label: Require experiment templates wrong, Experiment Template is a named resource Label: Require Experiment Templates right Label: Require unique experiment keys right, experiment key is a technical identifier Body: These are organizational defaults sentence case Body: ...move between growthbook accounts wrong, it is GrowthBook API error: Metric not found right, sentence case API error: This Saved Group is in use right, named resource stays Title Case API error: Invalid Data source ID wrong, it is Data Source实践要点什么时候检查这条规范对贡献者包括 AI Agent而言这条规范的触发条件非常具体只要改动落在packages/front-end/**/*.{ts,tsx}、packages/back-end/src/**/*.ts、packages/shared/src/**/*.ts三个范围内且涉及任何用户可见字符串——前端标签、标题、按钮、占位符、正文或后端错误/校验消息——就应当按本文的两级规则与词表核对。判定顺序可以概括为先问它是标题吗是则 Title Case再问这个词在词表里吗是则任何位置保持 Title Case再问它是技术标识符或普通名词吗是则小写其余按 sentence case 处理。由于.claude与.cursor下的触发器都只指向.agents/guides/ui-copy-style.md任何词表增删都应只更新这一份正文保证多助手、多入口看到的规范一致。赞分享后端前端数据分析数据可视化【免费下载链接】growthbookOpen Source Feature Flags, Experimentation, and Product Analytics项目地址https://gitcode.com/gh_mirrors/gr/growthbook点击查看免费下载相关推荐GrowthBook 文案风格指南双层大小写规则与命名资源大写规范Copy CasingGrowthBook 文案风格指南双层大小写规则与命名资源大写规范Copy Casing 本文基于 GrowthBook 仓库中的官方风格指南 .ag后端前端数据分析数据可视化Markdownlint项目中的MD044规则专有名词大小写规范详解Markdownlint项目中的MD044规则专有名词大小写规范详解 规则概述 MD044是markdownlint工具中的一项重要规则专门用于检查文档中特开发工具代码质量Lint静态分析SQLFluff规则CP02函数名大小写规范SQLFluff规则CP02函数名大小写规范 规则概述 SQLFluff规则CP02Capitalisation of Functions是SQL代码风格代码质量Lint格式化静态分析开发工具上一篇FunClip与AI大模型融合探索智能视频剪辑的未来发展趋势下一篇CAI容器化部署Docker与云环境的最佳实践创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考