首页 理论教育 如何撰写产品技术说明书

如何撰写产品技术说明书

时间:2023-06-20 理论教育 版权反馈
【摘要】:产品技术说明书的文体形式大致有两种,一种是专用式,这种形式的产品技术说明书需要装订成册,通常由封面、目录、正文、封底等几部分构成。请看下面例文的标题:××卫星电话技术说明书这是由产品名称、内容、文种三个要素构成的标题。(二)正文产品技术说明书的正文由开头、主体、结尾三个部分构成。有的产品技术说明书还要说明可以配备的其他有关备品。

如何撰写产品技术说明书

产品技术说明书的文体形式大致有两种,一种是专用式,这种形式的产品技术说明书需要装订成册,通常由封面、目录、正文、封底等几部分构成。一般情况下,这种说明书内容比较多,通常被用于对技术比较复杂的产品做技术说明。另一种是简要式,一般采用文章式的体式。简要式产品技术说明书,其实就是专用式技术说明书的正文部分,这种说明书多用于对内容不太多,技术不是很复杂的产品做出的技术说明。

我们这里只介绍专用式产品技术说明书,即简要式产品技术说明书,正文部分的写作。掌握了简要式产品技术说明书的写作知识,也就等于掌握了产品技术说明书的写作知识。下面为了叙述方便,把专用式和简要式两种体式的技术说明书,统称为产品技术说明书。

产品技术说明书其实就是一篇说明体式的应用文,其文体由标题、正文、落款三部分构成。下面分别介绍:

(一)标题

产品技术说明书的标题通常由被说明对象(产品的名称)、内容(性质)、文种三个要素构成。例如:《××型数控机床技术说明书》,这个标题中“××型数控机床”是产品的名称,“技术”是说明的内容,“说明书”是文种。有时标题也可以采用简化形式,如《产品技术说明书》《技术说明书》等,第一个标题中的名称是不定指的名词,第二个标题只有两个构成要素。

请看下面例文的标题:

××卫星电话技术说明书

这是由产品名称、内容、文种三个要素构成的标题。

(二)正文

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

1.开头部分

产品技术说明书开头部分的内容,通常是有关产品技术情况的概述,如说明产品的型号、名称、用途、性能等等,有时还要配上产品外形照片或者外形图。

例如《××卫星电话技术说明书》(选文略有改动)的开头部分:

产品名称:××卫星电话

产品型号:Thuraye×T

用途

本产品是第一个通过IP54/IK03认证的卫星电话,是结合萨拉亚卓越的可靠卫星网络。无论您在世界的哪个角落,让您轻松地与外界联通。具有短信、和弦铃声,支持12种语言(中文)和GPS功能语言。可以轻松地连接Internet接收/发送电子邮件、连接您的笔记本电脑进行网上冲浪

性能

本产品防摔,防水,防尘和防震,Thuraye×T是最坚固的卫星手机

配备超强电池,能为您提供长达6小时的通话时间,或是80小时的待机时间。

这是这篇产品技术说明书的开头部分,在开头部分里写明了关于该卫星电话产品三个方面的内容:一是产品的名称、型号,二是主要用途,三是性能。

2.主体部分

产品技术说明书的主体部分,需要详细写明产品的技术参数、工作原理、结构特征、安装调整、使用维修、运输包装(有关的其他配备)等内容。

技术参数:要求列出产品技术设计的依据,和产品所具有的技术数据和指标,包括计算的方法、技术指标实现的途径和方法等等。

工作原理:要求从产品的技术角度出发,使用通俗易懂的说明文字,以及必要的略图或者有关的示意图,来说明产品的工作原理。(www.xing528.com)

结构特征:就是要对产品的结构特点及组成进行说明,还要对产品的有关性能、指标等情况做出明确具体的说明。说明产品的结构特征可以配以产品的图片或者外形图。

安装调整:就是要对产品安装使用的地点,安装和调整的方法,安装调整需要注意的事项,有关安装使用人员需要注意的安全事项,设备安全必须注意的问题等等,做出具体说明。

使用维修:要求对使用者使用产品必须注意的事项、维修方法等,做出必要的说明。

运输包装:要对产品运输与包装的方法,以及主要的技术要求等,做出具体说明。有的产品技术说明书还要说明可以配备的其他有关备品。

再如上面例文的主体部分:

技术参数

频率:××MHz。通信系统:卫星。

内存:内部-高达32mb。接口:usb(1.1)。操作系统:Windows Vista,Windows XP,Windows NT,Windows 2000。

gmprs能力:下游高达60kbps的速度;上游高达15kbps的速度。传真和数据传输速度:9.6 kbps

结构特征与设备配置

显示屏幕:2英寸彩色显示屏。分辨率:128×128。尺寸:128毫米×53毫米×26.5毫米(高×宽×深)。重量:193克。

主机、电池、旅行充电器(包括3个插头)、耳机、USB数据线、备用天线插头、CD盘。

选购配件

汽车充电器、旅行充电器、USB数据线、备用电池、太阳能充电器

上面是这篇技术说明书的主体部分。这是一篇简要式的产品技术说明书,主体部分包括技术参数、结构特征等内容。结尾部分写明了可以选购的其他相关配件的名称。

3.落款

产品技术说明书落款部分的内容,通常要写明产品制造厂家的名称,名称前面常常要冠以“××制造厂商”的词语,还要写明联络方式,有时还要写明日期。

例如上面例文的落款:

××电子有限公司

联络方式:

地址:……电话:……

传真:……邮编:……

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

这个落款的内容包含了名称、联络方式等详细内容。

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

我要反馈