从实际建成记录开始
识别项目、机器序列号和交付配置。将客户特定改动和获准的文档修订版本与该记录关联。标准产品系列手册可以提供背景,但不应在未说明的情况下取代采用不同工位或选项的机器说明。
- 项目与机器序列号
- 实际建成配置修订版本
- 已安装工位
定制机械文档必须反映交付给特定客户的机器。当引导体验保留实际建成的配置、工位名称和获准流程,而不是借用相似标准产品的说明时,它才有用。
使用以下背景信息,让请求或任务便于审查:项目与机器序列号、实际建成配置修订版本、已安装工位、客户改动、任务负责人、获准验收记录。记录已核实和尚未明确的事项,再根据适用的产品资料确定下一项获准的操作。
识别项目、机器序列号和交付配置。将客户特定改动和获准的文档修订版本与该记录关联。标准产品系列手册可以提供背景,但不应在未说明的情况下取代采用不同工位或选项的机器说明。
使用操作员和服务团队在现场实际使用的工位名称。将每个工位与其原始图纸、控制装置和流程关联。客户说第二个模块不工作、而制造商使用另一个工位编号时,带标注的概览可以减少歧义。
定义任务属于操作员、维护团队、集成商还是机械制造商。保留文档规定的前提条件和升级处理负责人。指南不应仅仅因为步骤能在浏览器中展示,就把专业调试决策转交给客户。
编写示例:制造商在客户配置中记录可选检验工位。其指南只出现在这台机器的任务图中。其他配置的操作员不会收到从未安装过的组件的操作步骤。
记录改动对图纸、零件参考信息、控制信息和相关流程的影响。重新发布前审查关联指南。保留上一获准修订版本,可以让支持团队判断所报不一致是源于过时文档,还是未经记录的现场改动。
选择一项具有获准步骤和明确完成记录的任务。与制造商及执行任务的客户团队审查。评估指南能否确立正确配置和交接,而不是把客户验收视为查看说明后的自然结果。
为定制机械交互式文档准备一份将资料与实际任务关联的记录。将下方背景字段复制到自己的产品、支持或审查流程中。添加适用的资料参考信息和负责人,使下一团队能够看到仍需确认的事项。
记录项目与机器序列号、实际建成配置修订版本、已安装工位,并确定适用的资料。
使用“将变更反映到指南库中”的场景讨论范围,再与负责人审查实际任务和尚未完成的字段。
在生成的记录中保留客户改动、任务负责人、获准验收记录和尚未解决的问题。
可重复使用的步骤有助于编写,但制造商必须确认它们适用于交付配置。可选工位、改动和客户特定验收要求需要各自的源资料背景。
从适用的文档和现有图像,以及项目与机器序列号、实际建成配置修订版本、已安装工位开始。选择一个反复出现的问题,在扩展指南前让产品负责人审查相关资料。
这是说明性的编写或支持场景,不是客户案例研究或测量结果。可用它讨论所需的产品背景,并与来源责任人审核实际任务。
请准备一个产品及针对常见问题的获准资料。聚焦的演示可以展示带标注的图像、经审查的步骤或更清晰的支持记录,如何帮助核实项目与机器序列号以及实际建成配置修订版本。在扩展体验之前,就准备和审查达成一致。