SuperDoc修订跟踪与批注工作流:如何快速搭建在线Word合同审阅体验
SuperDoc修订跟踪与批注工作流:如何快速搭建在线Word合同审阅体验
SuperDoc 是一个运行在浏览器里的 DOCX 文档引擎,内置**修订跟踪(Track Changes)与批注(Comments)**能力,帮助你在网页上快速搭建"在线 Word 合同审阅体验":协作方提出修改、审阅人逐条接受或拒绝、讨论以批注线程形式留存,最后导出一份双方认可的 DOCX 文件。整个过程不需要你自己实现复杂的 OOXML 处理逻辑。
为什么 SuperDoc 适合做合同审阅 📄
在线合同审阅的核心诉求是:改动的每一步都可追溯,讨论不污染正文。SuperDoc 直接基于 OOXML 构建,编辑结果写回 XML,修订、批注、作者信息都保存在 DOCX 文件内部——用 Microsoft Word 打开导出的文件,审阅状态完全保留。
它还提供三件关键能力:
- 修订模式:编辑不会直接落到正文,而是成为"提案",记录改了什么、谁改的;
- 批注线程:对选中文字发起讨论,支持回复、解决、重新打开,正文保持不动;
- 权限控制:区分"只能提案的协作者"和"可以接受/拒绝的审阅人"。
快速体验可以参考官方入门文档:quickstart.mdx。
搭建在线审阅体验的完整流程
整个工作流可以拆成四步:提案 → 讨论 → 决策 → 交接。下面按步骤说明如何配置。
1. 用 suggesting 模式打开编辑器,让编辑变成修订
SuperDoc 提供三种文档模式,合同审阅场景通常从 suggesting 开始:
| 模式 | 行为 | 适用场景 |
|---|---|---|
editing |
文字直接修改 | 修改即生效 |
suggesting |
编辑自动成为修订提案 | 他人需要审阅修改 |
viewing |
只读 | 只看不改 |
在 suggesting 模式下无需单独开启修订开关——受支持的编辑默认就会生成修订。配置示例:
export const reviewOptions = {
documentMode: 'suggesting',
user: { name: 'Jordan Lee', email: 'jordan@example.com' },
};
把这段选项展开进 new SuperDoc({ ... })(Vanilla)或 <SuperDocEditor /> 组件(React)即可。user 配置的是当前登录用户的身份,修订提案会以此署名。详细指南见 track-changes.mdx 与 document-modes.mdx。
💡 提示:
viewing模式下还能通过viewing.trackedChanges选择看到original(原文)、markup(带修订标记)或final(接受后的预览),适合"只看不改"的法务阅读场景。
2. 用批注讨论,而不改动正文
批注用于提问和讨论:选中一段文字(比如交付日期),右键选择 Comment 即可发起线程。批注的生命周期:
| 操作 | 效果 |
|---|---|
| 回复 | 在同一讨论中追加消息 |
| 解决 | 标记线程为已完成,但消息保留 |
| 重新打开 | 已解决的线程重新激活 |
批注与修订分工明确:改文字用修订,讨论用批注。批注默认开启,无需额外配置。完整用法见 comments.mdx。
3. 接受或拒绝:三种决策结果
选中一条修订提案即可看到审阅操作,三种结果各有含义:
- 接受(Accept):保留提案结果,移除修订标记;
- 拒绝(Reject):撤销提案;删除类提案会恢复原文;
- 暂不决定:提案保留,留给下一位审阅人处理。
一个实用细节:默认情况下,"覆盖选中文字"这种替换编辑(如把 30 days 改成 60 days)会被合并为一条提案,一次接受/拒绝即可决定整个替换;如果你们的流程需要分别决策删除和插入部分,可以把 trackChanges.replacementMode 设为 'separate'。
4. 导出 DOCX,完成交接
审阅完成后通过 Export DOCX 导出文件。注意两点:
- 导出不会自动接受未决修订,未决定的提案会原样保留在文件中;
- 重新打开导出的文件即可验证:已接受的文字没有修订标记、被拒绝的编辑已消失、未决提案及其作者仍然可见。
文档加载与保存的完整流程见 load-and-save-documents.mdx。
配置审阅人权限:谁能提案,谁能决策 🔐
合同流程里,业务方通常只能提修改,法务才能拍板。SuperDoc 通过 interaction 配置控制实例可用的操作:
export const reviewOptions = {
documentMode: 'suggesting',
user: { name: 'Jordan Lee', email: 'jordan@example.com' },
interaction: {
trackedChanges: { allowDecisions: false },
},
};
设置 allowDecisions: false 后,协作者的编辑仍会变成提案,但接受/拒绝按钮不可用。批注权限则通过 interaction.comments.level 分三档控制:
| 级别 | 可执行的批注操作 |
|---|---|
read |
只读线程 |
write |
创建、回复、编辑、删除 |
resolve |
以上全部 + 解决/重新打开(默认) |
⚠️ 重要提醒:浏览器里的开关只是体验层的控制,不是授权边界。文档访问、身份验证和保存权限必须由你的后端强制执行,否则懂技术的人可以绕过界面直接发请求。权限设计的完整说明见 interaction-permissions.mdx 和 review-workflow.mdx。
如果多方需要同时编辑同一份合同,可以接入基于 Yjs 的协同功能,让修订和批注在共享文档中实时同步,参见 collaboration 文档。
进阶:让 AI 或脚本提案,由人来拍板 🤖
SuperDoc 的另一大亮点是"人审机改"工作流:通过 Node.js SDK 或 MCP 服务,让代码/AI Agent 直接对 DOCX 发起修订模式的编辑——比如把合同中的 Termin 批量替换为 cancell——保存出来的文件带有待审阅提案,再交给审阅人在编辑器里逐条接受或拒绝,最终决定权始终在人。
Document API 提供了配套的审阅接口:
trackChanges.list():分页列出未决修订(含作者、前后文);trackChanges.get():查看某条修订的完整 before/after 详情;trackChanges.decide():按修订 ID 编程式地接受或拒绝。
该工作流的完整教程(含 NDA 样例合同)见 review-tracked-changes.mdx,接口细节见 tracked-changes.mdx。
常用文档与示例清单
| 资源 | 说明 |
|---|---|
| editor/track-changes.mdx | 修订跟踪编辑器指南 |
| editor/review-workflow.mdx | 审阅工作流与权限设计 |
| editor/comments.mdx | 批注线程完整用法 |
| editor/document-modes.mdx | 三种文档模式与修订显示方式 |
| editor/interaction-permissions.mdx | 权限与交互控制 |
| document-api/tracked-changes.mdx | 编程式修订操作 API |
| examples/document-modes/ | 文档模式可运行示例 |
| examples/collaboration/ | 协同编辑示例 |
总结
搭建在线 Word 合同审阅体验的关键路径是:用 suggesting 模式收集提案 → 用批注线程集中讨论 → 用 allowDecisions 区分提案者与审阅人 → 导出 DOCX 完成交接。SuperDoc 把修订、批注和权限都内建在编辑器中,且审阅状态随 DOCX 文件走,Word 打开即见,让"网页审阅 + 线下归档"无缝衔接。配合 Document API,你还可以把 AI Agent 接进来当"初稿修改员",把最终签字权留给人。
