S1000D 数据模块类型与信息类型:描述、程序、零件、故障隔离
S1000D 数据模块以明确的主题边界承载技术信息。项目常根据读者任务选择描述、程序、零件、故障隔离等类型,再把图形、表格、视频和 3D 媒体作为内容对象或独立资源进行组织。类型选择影响 Schema、DMC、审核责任、复用方式和最终出版物结构。
数据模块类型和信息对象有什么区别?
数据模块类型决定一个模块的主要任务、允许结构和审核方式,例如描述模块用于解释系统,程序模块用于指导操作,故障隔离模块用于按症状和测试结果定位问题。图形、表格、视频、3D 模型和警告等则通常是模块内部的内容对象或被引用的媒体资源。
| 层次 | 回答的问题 | 示例 | 主要管理对象 |
|---|---|---|---|
| 数据模块类型 | 这份技术信息主要服务什么任务? | 描述、程序、故障隔离、零件、计划。 | Schema、DMC 信息类型、审核责任、PM 位置。 |
| 内容对象 | 模块中的信息如何表达? | 段落、步骤、警告、表格、列表、条件。 | 结构、顺序、代码值、业务规则。 |
| 媒体资源 | 读者需要什么图像或交互资料? | 图形、热点图、视频、音频、3D 模型。 | ICN/媒体标识、格式、版本、适用性和引用。 |
常见数据模块与信息类型对比
| 类型 | 主要目的 | 典型入口 | 常见内容 | 验收重点 |
|---|---|---|---|---|
| 描述类 Descriptive | 解释系统、部件、原理、接口或功能。 | 系统名称、部件或功能问题。 | 结构、工作原理、输入输出、限制、接口和术语。 | 描述与实际设备、图形、配置和术语一致。 |
| 程序类 Procedural | 指导人员完成操作、维修、检查或测试任务。 | 任务名称、工作包或维修步骤。 | 前置条件、工具、耗材、步骤、警告、判定、恢复和结束条件。 | 步骤可执行、顺序正确、安全信息完整、结果可验证。 |
| 故障隔离类 Fault Isolation | 根据症状、告警和测试结果定位故障。 | 故障现象、告警码或测试结果。 | 条件、测试、决策分支、可能原因、隔离动作和转修建议。 | 路径覆盖、分支逻辑、测试结果和引用程序正确。 |
| 零件 / 图解零件类 Parts / IPD | 识别零件、装配关系和订货信息。 | 部件号、图解位置或装配节点。 | 爆炸图、热点、零件清单、数量、位置、互换性和配置。 | 图形热点、件号、数量、层级和适用性一致。 |
| 计划与限制类 | 表达维护间隔、寿命、限制和计划任务。 | 周期、限制值、寿命或计划编号。 | 间隔、阈值、条件、单位、来源和计划逻辑。 | 数值、单位、适用性、版本和批准依据正确。 |
| 培训 / 其他项目类型 | 服务训练、评估或项目约定的专业信息。 | 课程任务、能力目标或特殊交付需求。 | 目标、步骤、媒体、考核、结果和参考资料。 | 与培训对象、课程版本和交付平台匹配。 |
同一出版物可能同时包含多个类型。PM 通过引用和目录把它们组合成 AMM、CMM、IPC/IPD、FIM、操作手册或培训课程;类型本身不等于出版物名称。
如何选择数据模块类型?
- 从读者任务开始:明确读者要理解原理、完成步骤、识别零件、隔离故障还是执行计划。
- 确定结果:写出任务完成的可观察结果,例如测试通过、部件更换完成或故障定位到可维修单元。
- 划分边界:把背景描述、可执行程序、故障决策和零件识别拆成可独立审核的主题,避免一个模块承担互相冲突的任务。
- 核对 Schema 与 DMC:确认采用的 Issue、模块类型、信息代码、SNS/DMC、代码表和 BREX 是否允许该结构。
- 确定媒体与适用性:判断图形、表格、视频和 3D 是否内嵌或独立引用,并定义型号、构型和语言范围。
- 写入 DMRL 和 PM:记录模块需求、责任人、依赖、验收条件,再用出版物模块组织读者可用的目录。
不同类型之间如何复用和引用?
复用的基本原则是让每个模块保持主题清晰、依赖可解释、适用性明确。一个故障隔离模块可以引用描述模块了解系统原理,也可以引用程序模块执行测试或更换任务;一个程序模块可以引用零件或图形模块,而不必复制完整正文。
| 引用关系 | 适合的场景 | 复用前要检查 |
|---|---|---|
| 描述 → 程序 | 程序需要读者理解系统、部件或前置原理。 | 描述版本、构型、术语和引用上下文。 |
| 故障隔离 → 程序 | 测试结果引导读者执行检查、拆装或恢复。 | 分支条件、返回结果、工具和安全前置。 |
| 程序 → 零件 / 图形 | 步骤需要识别件号、位置、热点或装配关系。 | 图形版本、热点、件号、适用性和显示效果。 |
| 多个 PM → 同一模块 | AMM、CMM、FIM 或操作手册共享相同安全和系统信息。 | 读者任务、前置条件、适用性和模块状态。 |
一个维修任务的类型组合示例
以“更换液压泵”为例,项目可以按读者任务把内容组合成如下模块关系。名称和标签只用于说明设计思路,实际结构要按正式 Schema 编制。
描述模块:液压系统原理与泵组接口
↓
故障隔离模块:压力不足 → 测试 → 定位泵组
↓
程序模块:拆卸旧泵 → 安装新泵 → 泄漏检查
├─ 引用零件模块:泵、密封件、紧固件和件号
├─ 引用图形模块:泵组爆炸图与安装热点
└─ 引用安全信息:压力释放和防护要求
AMM / FIM 通过 PM 组织各自需要的模块。
如果“压力不足”故障路径和“更换液压泵”程序在多个出版物使用,建议保持各模块的责任、版本和适用性独立,再用明确引用连接。这样既能复用,又能分别审核故障逻辑和维修步骤。
数据模块类型选型检查清单
- 任务:模块是否对应一个明确读者、入口、目标结果和审核责任?
- 类型:描述、程序、故障隔离、零件、计划或培训类型是否与 Schema 和 DMC 信息代码一致?
- 边界:背景说明、操作步骤、故障决策和零件识别是否拆分得足够清楚,避免模块过大或过碎?
- 结构:元素、属性、代码表、BREX 和媒体引用是否符合采用的 Issue 与项目规则?
- 复用:引用模块的版本、适用性、前置条件和上下文是否完整,是否能在多个 PM 中安全复用?
- 媒体:图形热点、表格、视频和 3D 资源是否可访问、可显示、版本匹配且与正文一致?
- 验收:模块是否通过结构与规则校验,并完成技术、安全、语言、配置和出版物级审核?
常见问题
S1000D 的数据模块类型有哪些?
常见类型包括描述、程序、故障隔离、零件或图解零件目录,以及计划、限制、培训和项目约定类型。实际名称和结构以采用的 Issue 与项目规则为准。
图形和表格是独立的数据模块吗?
图形、表格、视频和 3D 模型通常是内容对象或被引用的媒体,也可能由独立资源模块管理,具体由复用、适用性、格式和 Schema 决定。
描述模块和程序模块可以写在同一个模块里吗?
要看模块类型和项目规则。若内容边界、读者任务或审核责任不同,通常拆分更容易复用和验收,再通过引用连接。
如何选择故障隔离模块还是维修程序模块?
故障隔离以症状、测试和决策路径为入口,目标是定位故障;维修程序以明确任务为入口,目标是完成拆装、检查、调整或恢复。故障流程可以引用多个维修程序。
数据模块类型能否跨项目直接复用?
不能直接假设。需要核对 Issue、Schema、数据字典、BREX、DMC/SNS、适用性、语言和交付要求,必要时转换、重构并重新审核。