页眉:准确说明本指南适用的产品
记录产品名称、型号、款式、文档修订版本、语言、审批负责人和审核日期。列出适用的型号和任何排除项。说明读者是买家、安装人员还是受训技术人员。用户应能在拆开包装或开始作业前确认指南是否适用。
- 产品/型号:____
- 款式和来源文件版本:____
- 目标读者和审批负责人:____
一套实用结构,涵盖产品身份、零件、工具、步骤视觉资料、完成检查和支持交接。
组装说明模板是一套可重复使用的结构,用于说明适用的产品、前置条件、零件、操作步骤和预期结果。针对具体型号,使用经批准的规程填写模板,再请一位从未组装过该产品的人进行测试。
此模板用于整理文档,不规定通用组装方法,也不能取代产品负责人的技术审核。
记录产品名称、型号、款式、文档修订版本、语言、审批负责人和审核日期。列出适用的型号和任何排除项。说明读者是买家、安装人员还是受训技术人员。用户应能在拆开包装或开始作业前确认指南是否适用。
列出预期包装、所需工具、工作空间要求和制造商规定的警告。区分随附五金件和用户需要另行准备的物品。只有在已针对该产品确认的情况下,才填写预计时间和所需人数。说明如何在开始一项无法完成的组装前报告交付缺件。
每项物品都应列出手册图号、经批准的描述、数量和有用的图片。若有官方参考编号,也应添加。保留来源文件中的关键尺寸或表面处理代码。A 或 12 等图号只是示意图标签;除非制造商确实以此作为订购编号,否则不要将其标为供应商零件编号。
每个步骤使用以下记录结构:步骤编号、前置条件、所用零件/工具、单项操作、相关图片或视图、预期结果、来源警告,以及下一步或支持渠道。不要把多个无关操作合并到同一段动画中。提供易读的文字,不要让用户必须依靠动画、颜色或小型热点才能理解内容。
例如,橱柜组装步骤可以让读者识别示意图中板件的内侧,并展示两种可能的方向,说明预期的对齐方式。审核人员应根据经批准的手册和实际零件核对视图。记录文件中说明的方向和结果;不要为了让模板看起来完整而编造紧固件规格。
添加制造商的完成检查清单、剩余包装或备件信息,以及未解决问题的处理渠道。适当时请支持团队收集型号、步骤编号和照片。发布前检查零件数量、参考编号、链接、翻译以及所有展示的方向。产品版本更新后,重新核查受影响的步骤。
使用一个型号及其实际包装内容。
请技术负责人确认操作和结果。
分发前观察首次使用者的操作,并修正含糊的标签和判断点。
采用读者能够执行并核验的最小完整操作。如果某个步骤涉及另一个零件、视角变化较大或需要单独判断,就应拆分。
可以。产品身份、零件参考编号和步骤检查在两种形式中都适用。应为每种格式准备合适的视觉素材,并保持底层规程一致。
根据经批准的文档或经过适当审核的任务研究,添加特定产品的时间估算和人员要求。不要直接照搬相似产品的数据。
将该步骤标记为需要技术审核。不要用看似合理但未经核实的操作填补规程缺口,再将其作为经批准的内容发布。
发送现有的经批准手册、示意图或照片。申请免费的指南演示,让团队先评估一项产品任务,再决定如何扩展。