S1000D 程序步骤、警告与安全信息怎么编写?
程序类数据模块把准备、操作、检查和结束条件组织成可执行步骤。安全信息必须在正确的步骤附近清晰呈现,并与风险、工具、人员资质和设备构型保持一致。标签名称和层级以项目采用的 Issue、Schema、Data Dictionary 与业务规则为准。
程序类数据模块通常包含哪些部分?
一项维修或操作任务应先说明目标、适用条件和所需资源,再按顺序描述动作、判断、检查和收尾。将一个任务拆成清晰步骤,便于培训、现场阅读、变更审核和多种格式发布。
| 部分 | 要回答的问题 | 编制检查 |
|---|---|---|
| 任务前提 | 设备处于什么状态?需要哪些隔离、工具和人员资质? | 型号、构型、前置任务、环境与防护要求是否明确。 |
| 程序步骤 | 操作者按什么顺序完成动作?每步的对象和结果是什么? | 动作主体、位置、方向、力矩、数量和完成判据是否可执行。 |
| 判断与分支 | 检查结果不同,下一步如何选择? | 条件、分支、返回路径和故障后果是否完整。 |
| 结束与恢复 | 如何确认任务完成并恢复设备? | 复检、功能测试、工具清点和记录要求是否覆盖。 |
常见标签和作用
| 元素或概念 | 常见作用 | 注意事项 |
|---|---|---|
proceduralStep | 表达一个可执行的程序步骤或步骤层级。 | 步骤顺序、嵌套层级和完成判据要清楚。 |
warning | 提示可能造成人身伤害或重大风险的情况。 | 应靠近相关动作,说明风险和必须采取的措施。 |
caution | 提示可能造成设备、材料或任务损坏的情况。 | 不要用模糊措辞替代具体防护动作和限制条件。 |
note | 补充理解、背景或操作提示。 | 不能用普通说明掩盖必须执行的安全要求。 |
action、levelledPara 或项目约定结构 | 承载动作描述、说明和层级化内容。 | 以项目 Schema 和样例确认具体可用元素。 |
不同 Issue 和数据模块类型的结构细节可能不同。页面中的英文标签用于帮助检索概念,实际项目必须使用已批准的 Schema 和数据字典。
安全信息应该怎样编排?
先定义风险,再决定位置:安全信息应在操作者需要作出决定或执行动作之前出现。对于跨多个步骤都有效的要求,可在任务前提集中说明;对某一步骤特有的风险,应紧邻该步骤,并在发布和阅读器中保持醒目。
- 描述风险来源、可能后果和适用构型,不只写“注意安全”。
- 给出可执行的控制措施,例如断电、泄压、接地、佩戴防护用品或设置警戒范围。
- 明确需要的工具、人员资质和前置条件,避免把关键条件藏在普通段落里。
- 让图形、步骤、警告和检查结果互相引用,修订时一起回归。
- 按目标语言、阅读器和离线环境检查安全信息的显示顺序和可读性。
<proceduralStep> <warning>执行前确认液压系统已泄压。</warning> <action>断开并标识供电连接。</action> <note>若检查结果不符合要求,返回故障隔离任务。</note> </proceduralStep>
该片段只说明“步骤—安全信息—动作—提示”的关系,不是可直接交付的 Schema 样例。正式项目还需补齐身份、适用性、工具、人员资质和验证条件。
程序和安全信息的审核检查
| 检查层次 | 要发现的问题 | 责任角色 |
|---|---|---|
| Schema / BREX | 元素顺序、必填项、代码和项目规则违反。 | 内容管理员或工具校验人员。 |
| 工程技术审核 | 动作、参数、工具、构型和完成判据不正确。 | 设计、维修或试验专业人员。 |
| 安全审核 | 风险遗漏、严重程度错误、控制措施不可执行。 | 安全、适航或质量责任人员。 |
| 现场验证 | 步骤无法执行、顺序不合理、图文不一致。 | 实际操作人员和验证团队。 |
| 发布回归 | 分页、链接、搜索、翻译或离线阅读时安全信息不醒目。 | 发布与验收人员。 |
常见问题
Schema 校验通过是否代表程序安全?
不代表。Schema 和 BREX 主要检查结构与规则,程序的技术正确性、风险控制和现场可执行性仍需专业人员审核和验证。
warning、caution 和 note 可以随意互换吗?
不应随意互换。项目应先定义安全信息的含义、严重程度、位置和审核责任,再按采用的 Issue、Schema 和业务规则使用对应结构。