S1000D 出版物模块(PM)与适用性是什么?
出版物模块(Publication Module,PM)把已批准的数据模块组织成读者可用的手册结构;适用性则说明内容适用于哪些型号、配置、批次或条件。两者配合使用,才能从同一份源数据生成不同设备或构型的交付手册。
PM 如何组织一份手册?
PM 可以理解为发布目录和内容装配结构。它把章节、任务、数据模块和媒体按阅读顺序组织起来,并允许项目在同一套源数据上维护不同出版物。PM 自身不应复制数据模块正文,而是通过引用连接批准的源对象。
| 常见元素或标签 | 主要作用 |
|---|---|
pm | 出版物模块的根结构。 |
identAndStatusSection、pmAddress | 出版物的身份、标题、状态和管理信息。 |
pmEntry | 组织目录层级、章节和出版物节点。 |
dmRef、dmRefIdent、dmCode | 把出版物目录连接到具体数据模块。 |
pmRef | 在出版物之间建立引用关系。 |
适用性表达什么?
适用性用于回答“这段内容适用于哪些产品、型号、构型或条件”。例如同一设备不同批次采用不同液压泵,手册可以通过适用性让读者只看到对应配置的步骤。适用性必须和产品配置管理、代码表、测试数据及交付要求保持一致。
| 概念或标签 | 用途 | 注意事项 |
|---|---|---|
applic | 在对象上声明适用性范围。 | 确认作用域、继承和与 PM 的组合关系。 |
assert | 表达一个需要满足的适用性条件。 | 条件逻辑要能被工具和项目人员共同理解。 |
productAttribute、产品特性代码 | 描述型号、配置、批次等产品属性。 | 代码表、来源系统和变更流程必须一致。 |
condition、逻辑组合 | 组合多个条件以形成筛选规则。 | 测试真值组合,避免出现空内容或错误内容。 |
适用性标签和属性会随采用的 Issue 与项目配置而变化。页面只介绍工作概念,不能替代项目的适用性模型和正式样例。
从 PM 到交付物的流程
- 确定出版物类型、读者、设备型号、配置范围和交付格式。
- 根据 DMRL 和已批准模块建立 PM 目录,配置章节、任务和引用。
- 为模块、章节和媒体配置适用性条件,并核对产品配置代码。
- 用代表性型号和边界配置进行筛选测试,检查目录、引用和内容完整性。
- 生成 PDF、IETP、Word 或其他交付物,保留生成配置、源版本和检查结果。
- 在变更模块、产品配置或规则后重新执行影响分析和发布验收。
常见发布问题
- PM 目录引用了草稿或已废止的数据模块。
- 适用性代码在不同系统中含义不一致,导致筛选结果错误。
- 某个配置筛选后目录存在,但关键程序、图形或警告被过滤掉。
- 只测试一个“标准型号”,没有测试新旧批次、可选装置和边界组合。
- 交付包没有记录 PM、模块、规则和配置的版本,后续无法重现结果。
常见问题
PM 是数据模块吗?
PM 是组织出版物结构的模块,通常通过 DMRef 引用数据模块;它与承载具体技术内容的数据模块职责不同。
适用性筛选通过就代表手册完整吗?
不一定。仍需检查引用、媒体、目录、关键安全信息、配置边界和现场可执行性,并保留验收记录。