S1000D CSDB 是什么?数据模块、引用、版本与审核管理
CSDB 是 S1000D 项目的源数据管理环境。它不仅保存 XML 文件,还要维护数据模块、出版物模块、媒体、引用关系、版本、状态、适用性、责任人和审核记录,让同一份结构化内容可以被可靠重用和发布。
CSDB 管理的对象是什么?
CSDB 的核心对象包括数据模块、出版物模块、插图与媒体、数据字典、BREX 和项目管理元数据。它还需要知道对象之间如何引用、当前处于什么状态、谁可以修改、哪些版本已经批准以及哪些对象可以进入发布包。
| 对象 | 管理内容 | 与发布的关系 |
|---|---|---|
| 数据模块 | DMC、标题、状态、版本、适用性和正文内容。 | 作为可重用的源数据单元。 |
| 出版物模块 | 目录结构、PMEntry、DMRef 和阅读顺序。 | 组织一套手册或 IETP 的交付范围。 |
| 媒体对象 | 图形、图像、视频、表格和元数据。 | 由正文或模块引用并随包交付。 |
| 规则与字典 | Schema、BREX、数据字典、代码表和项目配置。 | 决定编辑、校验和发布的边界。 |
引用关系如何表达?
结构化手册通常通过引用建立模块之间的关系。正文可能引用另一个数据模块、图形或外部资料;出版物模块通过 DMRef 组织要交付的内容。CSDB 需要解析这些关系,检查引用对象是否存在、版本是否匹配、适用性是否冲突。
| 常见元素或标签 | 用途 |
|---|---|
dmRef、dmRefIdent、dmCode | 在出版物或正文中引用数据模块。 |
pmRef、pmRefIdent | 引用另一个出版物模块或出版物对象。 |
icnRef、figure、graphic | 连接插图、图形和媒体对象。 |
internalRef、外部引用结构 | 在模块内部定位相关段落、对象或外部出版物。 |
具体引用元素、属性和版本处理方式需要由采用的 Schema 和 CSDB 产品共同定义。页面上的标签只作概念索引。
CSDB 中的典型工作流
- 规划:根据 DMRL 建立模块任务、责任人、优先级和来源资料。
- 创建或导入:按 DMC 和模板生成模块,导入已有 XML 时保留来源和转换记录。
- 编写与校验:执行 Schema、BREX、引用、媒体和内容完整性检查。
- 审核与锁定:通过签出签入、审批、评论和状态流转,避免多人覆盖。
- 发布准备:按 PM、适用性和交付格式组装发布包,记录生成版本。
- 变更追踪:保留旧版本、影响范围和回滚关系,说明变更如何传递到相关手册。
选择 CSDB 工具时检查什么?
- 是否能按 DMC、标题、状态、项目和适用性检索。
- 是否能显示模块引用图、缺失引用和孤立对象。
- 是否支持签出签入、审批流、版本追踪和审计记录。
- 是否能把 Schema、BREX、数据字典和项目规则纳入校验。
- 是否能按 PM 和型号配置生成可复核的 PDF、IETP 或其他交付包。
常见问题
CSDB 是文件夹吗?
CSDB 是源数据管理环境,不只是存放 XML 的文件夹。它还要管理对象身份、关系、状态、版本、规则、权限和发布记录。
CSDB 与数据库产品是否等同?
CSDB 是一种技术出版物管理能力和工作环境,可以由不同产品实现;是否采用关系数据库、文件库或混合架构要看产品设计和项目要求。