S1000D 发布流程怎么做?从源数据到 PDF、IETP 与交付包
S1000D 发布不是把 XML 文件简单复制到一个目录,而是从已批准的源数据、出版物结构、适用性和媒体出发,按目标格式生成可验证的交付物。PDF、IETP 和离线交付包共用一部分源数据检查,但在导航、运行环境、安装和现场验收方面各有重点。
发布链路有哪些环节?
一个可追溯的发布链路通常从源数据基线开始,经过规则与结构检查、出版物装配、内容转换、媒体处理、目标格式生成、环境验证和交付归档。项目可以根据工具能力合并某些步骤,但不能省略对源版本、影响范围和最终输出的确认。
- 锁定源数据:确认 CSDB、数据模块、出版物模块、媒体对象、适用性配置、规则集和当前状态,生成源清单或快照。
- 确认发布配置:确定目标读者、设备/型号范围、语言、样式、媒体策略、目录组织和目标交付格式。
- 执行源数据检查:检查结构、业务规则、编码、状态、引用、适用性和媒体关系,关闭阻断发布的问题。
- 装配出版物:按已批准的出版物结构组织章节、任务、数据模块和媒体,确认目标配置不会出现空章节或缺失引用。
- 生成候选输出:使用已记录版本的转换器、渲染器或发布工具生成 PDF、IETP 或交付包,并保存运行参数和日志。
- 在目标环境验证:在打印、桌面、浏览器或离线部署环境中检查目录、导航、检索、适用性、媒体、警告和安全信息。
- 归档与批准:保存源版本、工具和配置、输出文件、哈希、检查报告、问题关闭记录和批准信息,形成可回退的发布基线。
发布前需要准备哪些输入?
| 输入对象 | 发布前要确认什么 | 缺失时的风险 |
|---|---|---|
| 数据模块与状态 | 模块身份、版本、状态、语言、作者/审核状态及适用范围。 | 草稿、废止或错误语言内容进入正式交付。 |
| 出版物结构 | 目录层级、章节顺序、模块引用、重复项和阅读路径。 | 目录空缺、顺序错误、引用断裂或读者无法定位内容。 |
| 适用性与配置 | 型号、批次、选装件、条件、代码表和边界组合。 | 筛选出不适用步骤,或目标配置没有内容。 |
| 媒体与附件 | 图片、图形、视频、音频、热点、附件路径、格式和授权。 | 媒体丢失、低清晰度、热点错位或交付包不完整。 |
| 规则与样式 | BREX/业务规则、Schema/校验包、模板、CSS、字体和分页策略。 | 源端看似正常,目标格式出现校验、排版或渲染差异。 |
| 交付配置 | 目标阅读器/浏览器、安装方式、权限、更新和回退要求。 | 现场无法打开、检索、更新或恢复上一版本。 |
具体输入名称和文件组织会因项目工具链而不同。发布记录应写明实际使用的工具、配置和版本,不要用页面示例替代项目正式配置。
PDF、IETP 与交付包有什么差异?
三种输出都可以来源于同一套 S1000D 数据,但验收对象不同。PDF 更接近固定版式的阅读和打印;IETP 强调结构化导航、检索、适用性筛选和交互阅读;离线交付包则关注内容与运行组件能否在约定环境中完整部署和维护。
| 交付形式 | 适合关注的能力 | 重点验收内容 | 常见交付证据 |
|---|---|---|---|
| PDF 或固定版式文档 | 阅读、打印、归档、签批和纸面引用。 | 封面/版本、目录、页码、分页、字体、图形清晰度、交叉引用和安全信息。 | PDF 文件、字体/渲染配置、页数和书签检查、抽样打印记录。 |
| IETP 或交互式电子技术出版物 | 按任务和结构导航,搜索、筛选、媒体和适用性互动。 | 启动、目录、导航、检索、筛选、媒体、链接、权限、日志与目标阅读器兼容性。 | 候选 IETP、测试账号/配置、浏览路径、截图或录屏、问题清单。 |
| 离线交付包 | 在隔离或受限网络环境部署、更新和回退。 | 目录完整、组件齐全、安装/卸载、数据路径、权限、校验、版本显示和回退可用。 | 压缩包/安装介质、哈希、安装说明、依赖清单、回退演练记录。 |
如果同一个项目同时交付 PDF 和 IETP,应把它们视为两个需要分别验证的输出,而不是对同一文件做两种包装。共同的源数据缺陷可以统一修复,但版式和运行环境问题必须在各自目标格式中重新检查。
发布前检查应覆盖什么?
源数据与规则
- 当前/目标 Issue、Schema、BREX、代码表和工具版本已记录,并与发布配置匹配。
- 数据模块、出版物模块、媒体对象和附件的状态允许进入该次发布。
- 结构校验、业务规则检查、编码检查和引用检查的阻断问题已关闭或有批准豁免。
- 适用性模型、产品配置和语言范围已确认,至少覆盖一个代表性配置和边界配置。
内容与媒体
- 目录、标题、任务顺序和导航路径与批准的出版物结构一致。
- 警告、注意、禁止、故障现象、工具/材料和必要的前置条件均可见。
- 图形、热点、视频、音频、附件、尺寸和链接在目标格式中可打开且位置正确。
- 外部引用、内部引用和跨出版物引用可解析;不存在孤立媒体或无目标链接。
输出与环境
- PDF 的分页、字体、书签、目录、页眉页脚、图形清晰度和打印结果通过抽检。
- IETP 的启动、导航、检索、适用性筛选、媒体交互、权限和离线行为通过抽检。
- 交付包的安装、目录权限、依赖、版本显示、更新和回退步骤在目标环境可复现。
- 输出文件、配置、日志、哈希、问题清单和批准记录已归档,可追溯到源数据。
离线交付怎么准备?
离线交付的核心不是“把文件复制到 U 盘”,而是在没有外部服务或网络不稳定的条件下,仍能按约定方式启动、阅读、检索、更新和回退。交付前要和客户确认运行系统、浏览器或阅读器、安装权限、媒体解码能力、数据存储位置和升级渠道。
| 交付包组成 | 需要说明或验证的内容 |
|---|---|
| 内容与索引 | 出版物、数据模块、媒体、索引/搜索数据和配置是否齐全,路径是否可迁移。 |
| 运行组件 | 阅读器、桌面程序、Web 静态资源或服务组件的版本、依赖、许可和启动方式。 |
| 部署说明 | 安装、初始化、账号/权限、数据目录、端口(如适用)、卸载和升级步骤。 |
| 完整性与安全 | 压缩包或介质哈希、签名(如项目要求)、病毒扫描记录、操作权限和备份策略。 |
| 回退与支持 | 旧版本保存位置、恢复顺序、已知限制、问题反馈渠道和支持期限。 |
“离线可用”只描述已验证的部署边界,不等于所有 AI、更新、外部链接或第三方服务都能在断网状态下工作。应在交付说明中逐项写清楚依赖和限制。
如何形成可追溯的验收证据?
验收记录要让没有参与发布的人也能复现结论。建议给每次发布分配唯一编号,并把以下证据与该编号关联:
| 证据 | 至少包含的内容 | 用途 |
|---|---|---|
| 版本矩阵 | Issue、Schema、规则、工具、配置、源数据和目标环境。 | 说明这次发布使用的基线,避免“同名不同版本”。 |
| 校验与转换日志 | 执行时间、工具版本、参数、错误/警告、人工处理和结果。 | 定位问题并重现转换过程。 |
| 输出清单 | 文件/目录、大小、哈希、生成时间、语言和适用范围。 | 确认交付包完整且未被替换。 |
| 目标环境抽检 | 测试配置、路径、浏览步骤、截图/录屏、缺陷和复测结论。 | 证明最终格式在客户环境中可用。 |
| 批准与回退 | 问题关闭、发布批准人、旧包位置和恢复步骤。 | 控制上线风险,支持后续修订和审计。 |
发布后变更怎么处理?
发布后发现问题时,先判断问题位于源数据、规则、转换、渲染还是部署环境。影响目录、适用性、安全信息、关键程序或大量媒体的变更,应重新评估发布范围;只影响排版或说明文字的变更,也应保留最小必要的复测证据。不要直接覆盖正式交付物而不留下版本、差异和回退信息。
- 冻结受影响版本,记录问题、发现环境、复现步骤和影响配置。
- 建立影响分析,明确需要修订的模块、出版物、媒体、索引和交付组件。
- 修复并重新生成候选输出,比较关键页面、导航、筛选和媒体结果。
- 更新版本说明、哈希和发布清单,完成批准后再替换或追加交付物。
- 保留旧包和恢复方案,通知使用方变更范围、生效时间及已知限制。
常见问题
S1000D 数据模块可以直接导出成 PDF 吗?
通常需要先通过出版物结构、样式、媒体和适用性配置组成目标内容,再由发布工具生成 PDF。单个数据模块通过结构校验,不等于已经具备完整目录、页眉页脚、引用和交付属性。
PDF 和 IETP 的发布检查一样吗?
基础的数据、引用、适用性和安全信息检查可以共用,但交付验证不同。PDF 重点检查分页、目录、字体、图形和打印结果;IETP 还要检查导航、检索、交互、权限、离线运行和目标阅读器行为。
离线交付包需要准备哪些内容?
应按项目交付要求准备内容文件、媒体、索引或数据库、阅读器/运行组件、配置文件、版本说明、安装与回退步骤及校验清单。具体目录和组件以项目部署方案确认,不应凭经验删减。
发布后发现一个数据模块有问题怎么办?
先冻结问题交付物并记录影响范围,定位源数据、规则、转换或渲染环节,再决定修订模块、重新组包或撤回版本。修复后应重新执行受影响检查,并保留旧包、变更说明和发布批准记录。
同一套源数据能同时生成 PDF 和 IETP 吗?
可以作为项目目标,但两种输出仍需分别配置和验收。共同的源数据缺陷可以统一修复,版式、导航、检索和运行环境问题则要在各自目标格式中单独验证。