镭

某车型用户手册 · DITA 术语制备全流程

术语抽取 → 术语库入库 → 生成 GLOSSENTRY Topic → 正文术语打标 → 使用反查 → 术语表发布

📋 16 条核心术语 🌐 中英双语 32 个 Topic ✅ 75 处正文打标 📦 4 大业务域分组 🔗 49 个 Key 定义

⚠️ 适用范围说明

本流程所涉及的工具与方法为镭内容出色中心内部技术资产。本文档面向 Oxygen XML 编辑器用户、DITA 文档工程师及管理层,旨在展示术语制备的方法与成果。

01任务概述

以《某车型使用说明书(钥匙至燃油加注)》的 DITA 源文件为对象(1 个 DITA Map + 19 个 Topic),利用中心自研的 DITA Termbase 管理工具 v1.2 完成一套完整的术语制备流程。该流程实现了术语的自动化抽取、标准化入库、多语言发布、正文智能打标与全链路反查,最终交付可直接挂入主 Map 的术语表章节。

19
源 Topic 文件
16
核心术语条目
32
GLOSSENTRY Topic
75
正文打标引用
49
Key 定义注册
4
业务域分组

最终成果物体现了 DITA 术语体系的三大核心特性,为 Oxygen XML 编辑环境与 DITA-OT 发布流水线提供了完整的术语基础设施。

DITA 特性 本项目的体现 业务价值
GLOSSARY ENTRY terms/ 目录下 32 个 glossentry 类型 Topic(16 条术语 × 中英双语),含 glossterm/glossdef/glossBody(glossStatus、glossPartOfSpeech、glossAlt/glossAcronym)与 prolog 元数据 术语定义单一来源,修改一处即可全局同步
GLOSSARY MAP glossary-h2.ditamap:以 <glossref> 引用全部 glossentry topic,可直接挂入主 Map 输出术语表章节 术语表作为标准 DITA Map 章节,天然融入出版流程
GLOSSARY GROUP 按业务域分为 4 个 <glossarygroup>(钥匙与智能系统/车门与锁止/车窗与天窗/燃油与电气),各组以 topicmeta/navtitle 命名 术语按业务场景分组,便于查阅与维护

02核心优势

本方案突破了传统 DITA 术语管理中"逐条手工录入、定义分散、打标易漏"的痛点,实现了面向文件组的批量自动化处理,在保持 DITA 标准完整性的同时,将术语制备效率提升了一个量级。

⚡

批量自动化

一次扫描 19 个 Topic 文件,自动识别高频领域术语并生成定义,告别逐条手工创建 glossentry 的低效模式。

🔗

Keyref 闭环

正文 <term keyref> 与 keydef Map 自动关联,49 个 Key 全覆盖,断链风险归零。

🌐

多语言就绪

每条术语自动生成中英双语 glossentry Topic,为全球化内容交付和后续语言扩展打好基础。

📊

全链路可追溯

从术语定义到正文每次引用均产生反查报告,术语使用频次、分布文件一目了然。

🏗️

业务域分组

术语按功能域自动归入 glossarygroup,术语表不再是平铺列表,而是有结构的业务知识地图。

🛡️

无侵入式操作

原始 DITA 源完全不动,打标输出至独立目录,风险隔离,随时可回退。

03术语制备流程

整个流程分为七个关键步骤,从源文件校验到最终主 Map 集成与全量验证,环环相扣,每一步都有明确的交付物和质量门禁。

0

DITA 源文件准备

从某车型 DITA 样本集合中提取 1 个主 Map 与 18 个 Topic;Map 中引用但缺失的 door_locking_overview.dita 按 Concept 信息类型补齐,使 19 个 Topic 全部通过 XML 解析校验,主 Map 无悬空引用。

✅ 19 个 Topic 全部通过校验
1

术语抽取

扫描 19 个 Topic 的正文词频,筛选出高频、有领域意义的候选词(如"智能钥匙"14 次、"天窗"15 次、"后背门"12 次),结合上下文撰写定义,产出 16 条候选术语。每条均携带首选术语、英文表面形式、缩略语、状态与业务域分类。

✅ 16 条候选术语 · 含定义与元数据
2

术语入库

将 AI 式术语抽取结果导入术语库,自动识别 glossentry 片段并解析各 glossary 元素,生成结构化术语记录,无需人工整理格式。

✅ 16 条术语结构化入库
3

生成 GLOSSENTRY Topic 与 Keydef Map

每条术语自动生成中、英两个语言版本的 glossentry topic(共 32 个),DOCTYPE 为 -//OASIS//DTD DITA Glossary Entry//EN。同时生成 keydef Map,注册 49 个 Key,覆盖术语首选语言、英文、缩略语三种引用场景,确保正文打标零断链。

✅ 32 个 Topic + 49 个 Key 注册
4

正文术语打标

在 19 个 Topic 中命中并包装 75 处术语引用,涉及 15 个文件,全部改写为 <term keyref="...">表面形式</term>。保护标签内的文本不会被嵌套打标;中文匹配按最长优先,避免"智能钥匙"被"钥匙"类词抢先截断。原始 content/ 目录保持不动,打标输出至 content-tagged/。

✅ 75 处打标 · 15 个文件 · 0 嵌套冲突
5

使用反查

对打标后的内容进行全量扫描,输出 keyref 使用反查明细,精确到文件、行号与元素类型。频次 Top:sunroof_zh(15 次)、smart-key_zh(14 次)、tailgate_zh(12 次)。反查确认 16 条术语中 15 条在正文有实际引用。

✅ 75 处引用可追溯 · 15/16 术语实际使用
6

术语表发布

按业务域分类发布术语表 DITA Map,4 个 <glossarygroup> 分组输出。同时支持"仅实际被引用"模式,按需发布精简版术语表,演示了按需发布能力。

✅ 4 组 Glossary Map + 按需发布模式
7

主 Map 集成与整体验证

在打标版主 Map 末尾集成术语库 keydef Map 与术语表章节。全量验证结果:74 个 XML 文件全部通过解析,正文 keyref 全部注册(0 断链),glossary map 全部 32 个 glossref 目标存在,主 Map 全部 topicref 目标存在。

✅ 74/74 XML 通过 · 0 断链 · 100% 引用完整

04关键成果示例

正文打标效果

出版时 <term> 经 keyref 间接寻址到 glossentry topic,可实现术语 hover 提示、术语表链接与统一样式。术语定义修改只需改 glossentry 一处,所有引用自动同步。

<title><term keyref="peps_zh">智能进入和启动系统</term>(<term keyref="peps_acronym">PEPS</term>)</title>

术语表 Glossary Map 结构

术语表不再是一个平铺的列表,而是按业务域组织的结构化知识地图,便于读者按需查阅。

<map id="h2-glossary" xml:lang="zh-CN"> <title>某车型使用说明书术语表</title> <glossarygroup outputclass="category-钥匙与智能系统"> <topicmeta><navtitle>钥匙与智能系统</navtitle></topicmeta> <glossref href="terms/smart-key_zh.dita" keys="smart-key_zh"/> <glossref href="terms/peps_zh.dita" keys="peps_zh"/> ... </glossarygroup> <glossarygroup outputclass="category-车门与锁止"> ... </glossarygroup> <glossarygroup outputclass="category-车窗与天窗"> ... </glossarygroup> <glossarygroup outputclass="category-燃油与电气"> ... </glossarygroup> </map>

05术语清单(16 条)

以下 16 条核心术语覆盖了说明书"钥匙至燃油加注"章节的全部关键概念,每条术语均配有中英文表述、状态与业务域归属。

ID 中文术语 英文术语 缩写 状态 业务域分组
smart-key 智能钥匙 Smart Key — preferred 钥匙与智能系统
mechanical-key 机械钥匙 Mechanical Key — preferred 钥匙与智能系统
peps 智能进入和启动系统 Passive Entry Passive Start System PEPS preferred 钥匙与智能系统
central-locking 中控锁 Central Locking System — preferred 车门与锁止
child-lock 儿童锁 Child Safety Lock — preferred 车门与锁止
door-ajar-warning 车门未关警告 Door Ajar Warning — preferred 车门与锁止
tailgate 后背门 Tailgate — preferred 车门与锁止
auto-relock 自动回防 Auto Relock — admitted 车门与锁止
anti-pinch 防夹功能 Anti-pinch Function — preferred 车窗与天窗
sunroof 天窗 Sunroof — preferred 车窗与天窗
sunshade 遮阳板 Sunshade — admitted 车窗与天窗
sunroof-initialization 天窗初始化 Sunroof Initialization — preferred 车窗与天窗
overheat-protection 过热保护 Overheat Protection — preferred 车窗与天窗
refueling 燃油加注 Refueling — preferred 燃油与电气
fuel 燃油 Fuel — preferred 燃油与电气
battery-12v 蓄电池 12V Battery — preferred 燃油与电气

📌 状态说明

preferred(首选):14 条,推荐在正文中优先使用的术语形式。
admitted(允许):2 条("自动回防""遮阳板"),在特定语境下可使用,但术语审订后可视需要提升为 preferred 或降级为 deprecated。

06工具版本演进

本流程基于中心 DITA Termbase 管理工具 v1.2 完成。相比 v1.1,v1.2 为达成 GLOSSARY GROUP 特性并保证 keyref 闭环,做了三处关键增强:

🏷️

业务域分类贯通

术语数据模型新增 category 字段,从 glossentry prolog 元数据中解析,生成的 Topic 也会回写该元数据,保证可再入库、可追溯。

📂

分组发布能力

DITA 格式发布时按业务域自动分组输出 <glossarygroup>,无分类时保持原有平铺行为,兼容已有项目。

🔑

缩略语 Key 注册修复

为缩写表面形式自动注册 {id}_acronym Key,消除正文 <term keyref="peps_acronym"> 的潜在断链风险。

07后续建议

🔧 发布流水线集成

在 Oxygen/发布流水线中启用 DITA-OT 的 glossentry 处理,即可让正文 <term> 自动生成术语表链接或悬停释义,进一步提升阅读体验。

📝 术语审订

术语审订后将 glossentry prolog 中 review-status 从 pending 改为 approved,并视需要将 admitted 术语提升为 preferred 或降级为 deprecated。

📈 增量扩充

手册范围扩展到其他章节时,重复流程即可增量扩充。合并模式(--merge)可保护 keydef Map 中的手工条目,确保已有工作不受影响。

🌍 多语言扩展

当前已具备中英双语 Topic,未来可在此基础上扩展更多语言版本,术语管理体系天然支持全球化内容交付。

08整体验证摘要

全流程交付物经过严格验证,确保在 DITA 生态中的完整性和可用性:

74/74
XML 文件通过解析
0
正文 Keyref 断链
32/32
Glossref 目标存在
100%
Topicref 引用完整