术语表、缩写、同义词和命名规则共同组成团队的术语规范体系,但各自承担的任务不同:术语表是收录标准术语及定义的清单,是体系的核心载体;缩写是术语在书写上的简写形式,通常登记为术语条目的一项属性;同义词用于把含义相同或相近的非标准说法映射回标准术语;命名规则则规定名称的格式、顺序和分隔方式,决定术语、缩写和同义词在具体名称中如何组合使用。理解这层分工,有助于团队在整理术语规范时判断每类内容该放在哪里、由谁维护。
要点总览(TL;DR)
- 术语表是术语规范的核心载体,缩写和同义词是挂在术语条目上的关联信息,命名规则是调用这些信息的规则层。
- 术语规范聚焦知识表达标准,基本组成包括术语表、缩写登记、同义词映射和命名规则,不包含需求模板内容与流程制度建设。
- 命名规则决定名称的格式与组合方式,术语表提供可用的词;命名时优先使用标准术语,缩写需已登记并注明使用条件。
- 术语表与普通词汇表的区别在于是否具有约束力,与数据字典的区别在于面向表达还是面向数据结构。
- 常见误解包括把同义词写进正式文档、命名规则脱离术语表维护、缩写不登记导致一缩多义。
一句话说清四者的关系
四者可以按“载体—条目属性—规则层”三层来理解。术语表是内容载体,回答“我们认可哪些说法、它们分别是什么意思”;缩写和同义词是挂在术语条目上的关联信息,回答“这个术语还有哪些写法”;命名规则是规则层,回答“在给对象起名时,这些词按什么格式组合”。
这个结构决定了维护顺序:先有术语表,缩写和同义词才有挂靠的位置;先有稳定的标准术语,命名规则才有可调用的词库。反过来,如果命名规则先于术语表建立,规则中引用的词往往来自个人习惯,容易出现同一对象多种写法、同一缩写指向多个概念的情况。
| 组成 | 角色 | 承载位置 | 主要约束对象 |
|---|---|---|---|
| 术语表 | 标准术语及定义的清单,体系核心载体 | 术语条目集合 | 概念的含义与标准写法 |
| 缩写 | 术语的书写简写形式 | 术语条目的属性字段 | 简写的唯一性与展开方式 |
| 同义词 | 非标准表达到标准术语的映射 | 术语条目的关联字段 | 表达的统一入口 |
| 命名规则 | 名称的格式与组合约束 | 独立的规则文档或规范条款 | 名称的结构、顺序与分隔 |
需要说明的是,这四类内容在规模较小的团队里可能合并在一份文档中,但角色分工不变。合并的是存放形式,分开的是维护责任:术语条目由业务或领域负责人确认含义,命名规则由需要统一命名的团队约定格式。
术语规范包括哪些内容:边界与组成
术语规范关注的是知识表达标准,即团队在文档、需求描述、界面文案、接口说明中如何使用一致的词。它的基本组成包括术语表、缩写登记、同义词映射和命名规则四部分,四者围绕“词”展开,服务于读写双方对同一概念的理解一致。
术语规范不包括具体需求模板的内容。需求模板规定一份需求文档应包含哪些章节、每个章节写什么,属于需求文档与规格管理的范畴;术语规范只规定这些章节中出现的词该怎么写、怎么统一。术语规范也不包括流程制度建设,例如评审流程分几级、谁有权批准发布,这些属于研发流程设计与标准化的内容。术语规范可以作为流程中的一份受控文档,但文档本身不定义流程。
可以用一个简单判断区分边界:如果一条内容回答的是“这个词是什么意思、还能怎么写”,它属于术语规范;如果回答的是“这份文档该有哪些部分”或“这件事该谁审批”,它属于其他主题。把边界划清,术语规范才能保持精简,避免变成一份什么都说一点、什么都不精确的混合文档。
术语表如何承载缩写与同义词
术语表的基本单位是术语条目。一个可用的条目通常包含几个字段:标准术语、定义、缩写、同义词,必要时补充使用说明或反义表达。标准术语是唯一推荐写法,定义说明概念的内涵和外延,缩写和同义词则是围绕这个标准术语的关联信息。
缩写作为书写简写形式登记在条目上,需要同时记录展开形式和使用条件。例如某个标准术语登记了缩写后,条目应能说明该缩写在首次出现时是否需要展开、在标题或表格中是否可以直接使用。这样处理的作用是让缩写的含义始终可回溯到唯一的标准术语,避免读者在不同文档中遇到同一串字母却对应不同概念。
同义词的处理方式是把非标准表达映射到标准术语。条目中可以列出若干常见但不再推荐使用的说法,并注明“统一使用标准术语”。这种映射的价值在于检索和替换:读者用旧说法搜索时能找到标准条目,编辑整理文档时也能据此统一替换。同义词本身不获得标准地位,它只是通往标准术语的入口。
一个术语对应多个缩写或多个同义词是常见情况,处理原则是分别登记、分别注明适用场景。多个缩写可能分别用于不同语境,例如界面展示用短缩写、技术文档用完整缩写;多个同义词可能来自不同部门的历史习惯。条目内并列登记并说明差异,比强行只保留一个更能反映实际使用情况,也便于后续逐步收敛。
命名规则如何调用术语表
命名规则规定名称的格式、顺序与分隔方式,例如“对象类型+业务域+限定词”的排列、词与词之间用连字符还是下划线、是否允许出现缩写。它本身不定义词的含义,词的含义由术语表提供。两者的分工可以概括为:术语表决定“用什么词”,命名规则决定“这些词怎么排”。
命名时优先选用术语表中的标准术语,是让规则可执行的关键。如果命名规则只写格式、不约束用词,不同人按同一格式仍可能写出含义不同的名称。把“优先使用标准术语”写入规则,命名结果就能与术语表形成对应关系,读者看到一个名称时也能回到术语表确认含义。
缩写在命名中的使用需要有条件。常见做法是:名称中优先使用完整标准术语;当长度受限或该缩写已被团队广泛认知时,允许使用已登记的缩写,并且同一批名称中保持一致。同义词一般不进入正式名称,它的作用是帮助理解与检索,命名仍以标准术语为准。
命名规则与术语表冲突时,处理原则是先确认冲突性质。如果规则引用的词在术语表中已变更,应以术语表为准并同步修订规则;如果规则对某个词的使用有额外限制,例如禁止在某类名称中使用缩写,则应在规则中写明该限制并回写至术语条目的使用说明。冲突不应长期并存,否则执行者只能凭个人判断选择,规范也就失去了约束作用。
相邻概念区别:术语表与词汇表、数据字典
术语表与普通词汇表的主要区别在于是否具有约束力。词汇表通常用于解释和查阅,收录词条并给出释义,读者了解即可;术语表则带有团队约定性质,标准术语是推荐甚至要求使用的写法,同义词被明确标注为非标准表达。换句话说,词汇表回答“这个词什么意思”,术语表还回答“我们该用哪个词”。
术语表与数据字典的区别在于面向对象不同。术语表面向表达,服务于文档、沟通和命名中的用词一致;数据字典面向数据结构,描述字段名称、类型、长度、取值范围、约束关系等,服务于系统设计与数据管理。两者可能共享部分名词,但数据字典中的字段定义不能替代术语表对业务概念的解释,术语表也不承担字段类型和取值的描述职责。
缩写表与术语表的关系是部分与整体的关系。独立的缩写表可以作为一种查阅视图存在,方便快速查找某串字母的展开形式;但在规范体系中,缩写应登记在对应术语条目上,缩写表只是从术语表派生出的索引。如果缩写表脱离术语表单独维护,就容易出现缩写已登记、对应术语已更名或废弃的情况,索引与内容脱节。
具体例子与常见误解
以下为演示情景,用于说明四者如何配合,不代表真实团队案例。假设团队要统一“应用程序编程接口”相关表达:术语表收录标准术语“应用程序编程接口”,定义说明其指系统之间按约定进行数据交换的接口;条目登记缩写“API”,注明首次出现时展开、后续可直接使用;同义词字段列出“接口”“服务接口”等历史说法,标注统一使用标准术语。命名规则据此规定:文档标题和正式名称中使用完整标准术语,表格列名等空间受限处可使用已登记的缩写,名称中不出现同义词。这样,一个词从含义、简写、旧说法到实际命名,都有明确出处。
常见误解之一是把同义词直接写进正式文档。同义词的作用是帮助映射和检索,正式文档中混用多种说法,会让读者难以判断它们是否指同一概念,也削弱了术语表的约束力。正确做法是在术语表中登记同义词,在正式文档中统一使用标准术语。
常见误解之二是命名规则脱离术语表单独维护。规则文档只写格式、不引用术语表,时间一长,规则中的示例词与术语表不一致,执行者无所适从。命名规则应与术语表建立引用关系,术语变更时同步检查规则。
常见误解之三是缩写不登记,导致一缩多义。同一串字母在不同团队分别指代不同概念,读者只能靠上下文猜测。把缩写登记到术语条目,并注明展开形式和使用条件,可以从源头减少这类歧义。
术语规范要长期可用,需要有稳定的承载位置和可追溯的修改记录。团队可以将术语表、命名规则作为知识库中的受控文档管理,借助 ONES Wiki 集中沉淀项目规范与技术文档,通过页面模板库创建制式化文档模板,让术语条目的字段结构保持一致;文档实时同步并记录页面版本,支持随时查看与回滚,便于追踪术语和规则的变更;权限控制可按角色配置读写范围,使术语条目的确认与日常查阅分开。术语表是否需要结构化的专用字段,属于选型时的核验点,可结合团队条目规模评估。
常见问题
团队规模较小,四类内容可以合并成一份文档吗?
可以合并存放,但角色分工不变。术语表、缩写、同义词和命名规则在规模较小的团队里常放在同一份文档中,便于查阅和维护。合并的是存放形式,分开的是维护责任:术语条目的含义由业务或领域负责人确认,命名规则由需要统一命名的团队约定格式。随着条目增多,可以考虑把命名规则拆出独立维护,避免格式条款与术语条目频繁互相干扰。
缩写已经在团队内广泛使用,还需要登记到术语表吗?
建议登记。广泛使用说明它已经进入实际表达,更需要有明确的出处。登记时记录展开形式和使用条件,例如首次出现是否展开、在标题或表格中能否直接使用,可以让缩写的含义始终回溯到唯一的标准术语。不登记的风险是同一串字母在不同文档中指向不同概念,读者只能靠上下文猜测。
命名规则和术语表出现冲突时,应该先改哪一个?
先确认冲突性质再决定。如果规则引用的词在术语表中已经变更,应以术语表为准,并同步修订规则中的示例和用词;如果规则对某个词有额外限制,例如禁止在某类名称中使用缩写,则应在规则中写明,并回写到术语条目的使用说明。冲突不宜长期并存,否则执行者只能凭个人判断选择,规范就失去了约束作用。
术语表需要做成结构化的专用工具吗?
取决于条目规模和使用频率。条目较少、更新不频繁时,用文档维护术语表并保持字段结构一致即可满足查阅和引用需求。条目数量增长、多人同时维护、需要按字段检索或与命名规则联动时,可以评估是否采用结构化登记方式。选型时可重点核验字段自定义、版本记录和权限控制是否满足团队需要。
术语规范文档放在知识库里,如何保证修改后大家用的是最新版本?
关键是让文档有唯一受控位置和可追溯的修改记录。团队可以把术语表和命名规则作为知识库中的受控文档管理,借助 ONES Wiki 集中沉淀项目规范与技术文档,通过页面模板库创建制式化文档模板,让术语条目的字段结构保持一致;文档实时同步并记录页面版本,支持随时查看与回滚,便于追踪术语和规则的变更;权限控制可按角色配置读写范围,使术语条目的确认与日常查阅分开。
