首页 理论教育 如何编写产品使用说明书

如何编写产品使用说明书

时间:2023-06-20 理论教育 版权反馈
【摘要】:由于产品实际的类别、性能以及构造的不同,产品使用说明书对规定的内容要素,会做出不同的选择性使用。“概述”部分,是产品使用说明书必须具备的一项内容。以上自第二项“主要技术指标”至第七项“一般故障及排除方法”,是产品使用说明书的主体部分。一般情况下,产品使用说明书以“其他事项”为结尾,结束全文。

如何编写产品使用说明书

产品使用说明书有简要式和专用式两种形式,在这里只介绍专用式产品使用说明书的写作。

专用式产品使用说明书一般需要装订成册,作为产品的附件随产品交付给使用者。专用式产品使用说明书的结构包括封面、目录、正文、封底等几项内容。其实,这种说明书的核心内容在正文部分,我们只要掌握了构成产品使用说明书正文的内容,也就掌握了这一文体的写作方法。

产品使用说明书,实际上就是一篇说明体的文书,其文体结构由标题、正文、落款几项内容构成。

(一)标题

产品使用说明书的标题一般由产品说明对象(产品名称)、内容(性质)、文种三个要素构成,如《××型家用吸尘器使用说明书》《××牌摩托车产品使用说明书》,《××型挖掘机使用说明书》等,其中“吸尘器”“摩托车”是说明对象,“使用”是内容,“说明书”是文种。

(二)正文

产品使用说明书正文部分的结构由开头、主体、结尾三部分构成。

一般来说,产品使用说明书的内容,应该具有一些固定的构成要素,其正文的内容通常包括概述、主要技术指标、产品重量尺寸、工作原理、安装使用方法、注意事项、保养方法、一般故障及排除方法、其他事项等。从文体结构角度看,“概述”是全文的开头部分,“其他事项”可以看做结尾部分,第二项“主要技术指标”至第七项“一般故障及排除方法”是主体部分。

由于产品实际的类别、性能以及构造的不同,产品使用说明书对规定的内容要素,会做出不同的选择性使用。一份内容比较完整的工业产品使用说明书,应该具备上述正文部分全部的规定内容,简要的产品使用说明书,可以根据产品的实际情况和使用者的实际需要来进行选用。

1.概述

概述也称为前言,是全文的开头部分。在概述部分的内容里,要对产品的设计目的、主要用途、主要特点、适用范围等情况,进行简要的说明。有的产品使用说明书,在概述部分还对产品的生产企业作一些必要的介绍,如企业的生产规模、技术力量、产品影响力等等。“概述”部分,是产品使用说明书必须具备的一项内容。

2.主要技术指标

在产品使用说明书里,要写明产品的各项性能指标、技术参数等方面的内容。如:适用温湿度的标准和范围、压力指标、电压范围、仪器仪表精确度及误差、额定的输出功率和输入功率等等。这一项内容要根据不同的产品,来确定内容进行选择说明。

3.产品重量、尺寸

产品的重量、尺寸,指产品的重量、规格、外形,及安装尺寸(可以分开)等。要根据具体的产品来进行表述。

4.工作原理

在这一项中要简要地介绍产品的设计原理、工作原理,以便让使用者对产品的构造、性能、原理有个基本认识,为使用者操作维护产品提供帮助。这一项是工业产品说明书的必选项。

5.安装、使用方法和注意事项

任何种类的产品说明书,都需要向使用者说明产品的安装方法、使用方法和注意事项,这是产品使用说明书的核心内容。这一项的说明方法,通常是按照产品的操作顺序逐一说明,也可以按照构成产品各个部件的结构顺序进行说明,还可以按照产品的原理、性能、功用等分项说明。在这一项里,常常配以简图、照片等,以图文并茂的形式进行说明。这一项内容是产品使用说明书的必选项,无论哪一种产品使用说明书,都不可缺少这项内容。

6.保养方法

这一项是要说明对产品保养、维护的方法,帮助使用者正确地使用产品,达到延长产品使用寿命的目的。保养方法是产品使用说明书的必选项,有时也可以把这一项放在第三项里去说明。

7.一般故障及排除方法

在这一项里,要向使用者说明,产品使用过程中可能出现的故障现象,以及一般故障现象的排除方法。这里所谓的故障现象,一般是指产品可能会出现的比较简单的,使用者可以根据产品使用说明书自行解决的,一些故障问题。这一项的说明,一般采用“故障现象、原因分析、排除方法”的“三段式”说明方法,可以采用文字加表格的形式来说明。一般来说,工业产品说明书,都需要对这一内容进行说明介绍。

以上自第二项“主要技术指标”至第七项“一般故障及排除方法”,是产品使用说明书的主体部分。

8.其他事项

其他事项包括产品售后服务办法、易损零件明细表、产品配备的成套零件和工具、其他图、表、照片等等。写作时要根据具体的产品来选择说明。一般情况下,产品使用说明书以“其他事项”为结尾,结束全文。

例如,下面这篇《不锈钢电汽两用三门蒸饭车》的产品使用说明书:

一、概述

产品品牌:×××牌。产品型号:KZ360。

本产品为电汽两用蒸饭柜,即电热管加热或锅炉产的蒸汽加热。

蒸饭车以角钢为主架,内外采用优质不锈钢板精心焊接而成,其结构紧凑牢固,保温层选用优质材料,最长保温时间可达四小时以上。车底部装有定向轮和变向轮各两个,以便挪动,一边有推拉把,以推拉使用。本机装有压力表和安全阀,能及时显示调节蒸汽压力。

该产品具有造型美观、结构合理、清洁卫生、移动灵活、操作方便、保温性好、坚固耐用、一车多用等优点,是当今较理想的厨房设备。我厂生产的电、汽两用消毒蒸饭车远销全国各地,深受广大用户的欢迎,在国内市场上享有一定的声誉。

二、结构特点

1.采用耐热聚氨酯整体发泡工艺、保温、隔热、节能、高效、环保

2.流畅外观、操作简便、快捷。

3.新式耐高温胶门封,密封牢固。

4.采用德国进口元器件,用电更节省,更安全。(www.xing528.com)

5.机体采用进口全优质不锈钢制作,清洁卫生,坚固耐用,符合卫生标准。

6.独特设计的简易式渐进门锁,方便实用。

7.全自动浮球进水功能,缺水自给,满水自停,防止干烧。

8.安全卸压气阀,保障机体安全使用。

9.一次性冲压成型的不锈钢蒸盘和层架,清洁卫生,经久耐用。

三、主要技术指标

1.蒸米饭:150~180 kg。蒸馒头:120~140 kg。蒸饭时间:25~30 min。消毒时间:20 min。消毒温度:100 ℃。

2.技术参数:电压380 V,功率36 kW,外形尺寸:2 100 mm×540 mm×1 530 mm。输入汽压:0.06 MPa。

四、注意事项及保养说明

1.蒸饭柜侧下方卸压阀是多余蒸汽及废汽的排放通道,切忌不可用重物压住或堵塞,亦不可外接管道来排放蒸汽,以免管道堵塞造成意外事故

2.浮球阀应经常检查是否正常,及进水是否通畅,如发现进水处结垢、堵塞应尽快进行处理,以免造成缺水干烧。

3.外接蒸汽时应注意:在蒸汽接入蒸饭柜前,必须在蒸汽管道上安装减压阀。本蒸饭车非高压密闭性容器,使用时应注意调整蒸汽输入压力,不可超压使用,以免造成危险。

4.每次蒸饭之后要放尽水箱中的余水,并且每周两次清除水垢,以防水垢在浮球阀及发热管上聚积,引起球阀堵塞及发热管干烧。如遇结垢可用5%的柠檬酸溶液注入水箱中,加热煮沸15 min,浸泡1 h,再煮沸15 min,然后将水垢清除,放走箱底中的污水,再用清水洗几遍即可。

警告:

1.不可用利器或硬物对发热管表面的水垢进行铲割,以免破坏发热管壁引发漏电!

2.清洁机体外围及机底时不可用喷水管进行清洗,以免溅湿电器部件引发触电危险。

3.每次工作完毕后,必须切断蒸饭车电源,用蒸汽加热时工作完毕应关闭总进气阀。

4.若电源引线老化或绝缘层破坏,必须立即停止使用!并更换相同规格型号的电源引线后方可继续使用蒸饭柜。

5.本机外壳必须妥善接地,以确保正常使用和操作安全。

6.长期不使用或进行维修时必须切断总电源、气阀及放尽箱底余水并擦拭干净。

7.若机器出现故障,切勿自行拆卸,应请专业的电器维修人员进行维修或与经销商取得联系。

五、其他事项

本产品自售出之日起,半年内凡属制造质量问题,服务上门免费维修,如属使用不当或人为原因造成损坏,在保修期内收取成本费,产品终身代为修理。

本说明书内容解释权归我公司(注:由于款式更新,技术改进等原因造成技术参数及线路图改动,恕不另行通知)

×××厨用电器公司

地址:……电话:……邮编:……

传真:……电子邮箱:……网址:……

这是一篇关于“两用蒸饭车”产品的使用说明书,正文部分由开头、主体、结尾构成。全文采用了产品使用说明书内容的基本要素,包括概述、结构特点、主要技术指标、注意事项及保养说明、其他事项等。其中,“概述”相当于开头部分,“其他事项”相当于结尾部分,中间三项是主体部分。全文重点说明了“注意事项及保养说明”一项的内容,最后以“警告”的方式提醒使用者,在使用本产品时应该遵循的一些事项,并向用户做了操作时不可违背的七项原则性警示。

(三)落款

产品说明书落款部分的内容要写明:生产单位的名称、联系方式(包括电话、邮编、传真、电子邮箱、网址)等等,以便于用户与企业联系与沟通。

如上面例文的落款部分:

×××厨用电器公司

地址:……电话:……邮编:……

电子邮箱:……网址:……

这个落款包含了生产企业名称,各种联系方式等内容。

免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。

我要反馈