把写作规范变成编辑器里的实时检查
为约二十人的技术文档团队私有化部署 DocQA,把企业自己的写作规范沉淀成 21 个规则包,检查能力直接嵌进团队日常使用的 oXygen XML Editor。
§01
客户挑战
这家企业的技术文档团队约二十人,产出用户手册、安装手册、维护手册、安全规程等多类文档,全部基于 DITA 在 oXygen XML Editor 中编写,体量大、版本多。
问题不在于没有规范,而在于规范执行不下去:
- 写作规范写在文件里,执行靠人盯人;同一份稿子换个评审人,结论就不一样
- 同一个部件在不同产品线上叫法不一,靠人记、靠搜,容易漏
- 安全与合规表述一旦缺失风险很高,但逐条人工核对成本大
- 新人产出质量波动明显,培训周期长
- 文档内容敏感,任何方案都必须做到数据不出内网
§02
解决方案
我们把「规范」这件事从文档搬进了工具链。
- 规范规则化:把企业自己的中文写作规范拆解成 21 个规则包、上百条规则,覆盖数字、单位、空格、标点、词法、句法、标题、段落、列表、表格、步骤、安全警示、术语缩略语等,以 YAML 为真相源,可在 Web 端可视化启停与调整
- 混合检查引擎:确定性问题走正则、本地零成本执行;语义层面的判断交给大模型;两路结果合并去重后按六个维度评分
- 嵌入写作过程:oXygen 插件支持对全文、选中段落或整本手册发起检查,问题以三级配色高亮在正文上,右侧面板给出修复优先的卡片,一键接受即原地修复
- 二次复核:同一句话触发多条规则时合并为一条统一改写,避免多条建议互相冲突,也把误报压下来
- 术语治理:建立中英平行术语库,检查时自动识别未收录、写法不一致、使用禁用词三类问题
- 私有化部署:内网 Docker Compose 部署,对接企业自有大模型,文档内容与检查全程不出内网
- 校准闭环:误报可由专家采纳为豁免、漏报可注入样例,并有回归机制防止「越校越坏」,系统越用越贴合团队的口径
§03
项目成果
系统于 2026 年 4 月完成首次内网部署,此后持续迭代十余个版本,已成为该团队日常写作流程的一部分。
- 质量把关从「交付前人工通读」前移到「写作过程中即时反馈」
- 引入二次复核机制后,内部样本实测误报率下降 30–50%
- 写作规范不再是一份需要人去记的文件,而是可执行、可版本管理的规则集
- 新人在写作过程中即时获得反馈,边写边学,质量波动明显收敛
21
规则包
6
质量评分维度
30–50%
误报率下降(内部样本实测)
100%
内网闭环,文档不出网