【壓縮機網(wǎng)】企業(yè)每推出一款新產(chǎn)品,壓縮機使用說(shuō)明書(shū)的編寫(xiě)是避免不了的工作任務(wù),本文筆者結合多次撰寫(xiě)說(shuō)明書(shū)的經(jīng)驗,來(lái)分享說(shuō)明書(shū)的編寫(xiě)過(guò)程。
說(shuō)明書(shū)是以應用文體的方式對產(chǎn)品來(lái)進(jìn)行相對詳細的描述,方便人們認識和了解。說(shuō)明書(shū)有指導客戶(hù)使用產(chǎn)品的作用,同時(shí)也是公司的宣傳冊,是與客戶(hù)簽訂的“契約”。凡是客戶(hù)必須知道的地方,說(shuō)明書(shū)中不能遺漏一點(diǎn),從而保證有效指導,提高產(chǎn)品使用的安全、壽命,如若內容不明確,可能會(huì )引起誤會(huì ),甚至招來(lái)糾紛。此外高質(zhì)量的說(shuō)明書(shū)也可以激發(fā)客戶(hù)再次購買(mǎi)的興趣。
編寫(xiě)說(shuō)明書(shū)要有一個(gè)大概的框架??梢园凑誈B/T9969《工業(yè)產(chǎn)品使用說(shuō)明書(shū) 總則》附錄A中提供的標題作為框架,其邏輯性強,不會(huì )產(chǎn)生遺漏。然后對照標題去尋找相應的內容,分列項目、逐項說(shuō)明,各項目明白地羅列出來(lái),使客戶(hù)看的明白。當然,可以根據具體產(chǎn)品的特點(diǎn)和使用要求對標題進(jìn)行增減及合理排序。其中特別要注意的是,使用說(shuō)明書(shū)應提供必要的保護環(huán)境和節約能源方面的內容,不能刪減。這是一種社會(huì )責任和義務(wù),也是標準的要求。
說(shuō)明書(shū)不同于普通的文章,其設計和編寫(xiě)都有規矩,可以參照標準GB/T 19678《使用說(shuō)明的編制 構成、內容和表示方法 第一部分:通則和詳細要求》。標準中規定了設計和編寫(xiě)各類(lèi)使用說(shuō)明的一般原則和詳細要求。作為與客戶(hù)溝通的媒介,使用說(shuō)明書(shū)中相關(guān)信息的描述和細節應通俗易懂,符合壓縮機客戶(hù)群體的知識水平,使用說(shuō)明應遵循客戶(hù)群體的切實(shí)需求,提供充足的細節信息并保證相關(guān)信息的完整性。內容書(shū)寫(xiě)的基本要求和編制方法在標準中也寫(xiě)的很明白,大家可以自行翻閱,這里不再贅述。標準中帶有“應”字段的內容要求在說(shuō)明書(shū)中要體現出來(lái),標準中帶有“宜”字段的內容可以根據自身特點(diǎn)選擇使用。
說(shuō)明書(shū)內容務(wù)必明白、準確才能使讀者完全理解,沒(méi)有含糊、誤會(huì )的弊病。以中壓無(wú)油空壓機使用說(shuō)明書(shū)為例。在動(dòng)手寫(xiě)說(shuō)明書(shū)的時(shí)候,作者心中不能存在一些連自己也理不太清楚的地方,落到紙面不能有一句不合理的,足以發(fā)生疑義的文句。這是一個(gè)消極條件,如果不顧這個(gè)消極條件,寫(xiě)下來(lái)的說(shuō)明書(shū)就達不到它的目的。自己拿不準的,比如性能參數、壽命周期等等這些內容可以向相關(guān)技術(shù)人員請教確認。我們可以按標準列出提綱,請求技術(shù)人員來(lái)協(xié)助完善。另外,說(shuō)明書(shū)的內容還要參考一些專(zhuān)業(yè)標準。GB/T10892-2005《固定的空氣壓縮機安全規則和操作規程》第14~22章有用戶(hù)應履行和遵守的要求,特別是壓縮機的安裝、管道系統和壓縮機的操作要求是客戶(hù)必須掌握的,要在說(shuō)明書(shū)中體現出來(lái)。
GB22207-2008《容積式空氣壓縮機安全要求》中4.4.3超溫停車(chē)裝置靈敏性檢驗,介紹了檢驗方法和次數。5.4使用說(shuō)明,介紹了說(shuō)明書(shū)中必須包含的內容,根據機型可增減;JB/T 10683-2006《中、高壓往復活塞空氣壓縮機》和JB/T 8933-2008《全無(wú)油潤滑往復活塞空氣壓縮機》標準中有關(guān)于保修期、用戶(hù)環(huán)境要求和針對無(wú)油高壓空壓機的專(zhuān)用條款,摘錄出來(lái)寫(xiě)到說(shuō)明書(shū)里。有關(guān)壓縮機環(huán)境保護方面可參照標準GB50894-2013《機械工業(yè)環(huán)境保護設計規范》。法律方面的問(wèn)題,可以在說(shuō)明書(shū)完成初稿后,由法務(wù)審定,特別是售后服務(wù),責任邊界方面要定義清楚,不能含糊。其它機型的產(chǎn)品也有相應的標準要求,一般行業(yè)標準的內容要比國家標準更加詳細,其參照的規范性引用文件也是標準巡查的線(xiàn)索。
說(shuō)明書(shū)要指導用戶(hù)使用產(chǎn)品,就要充分考慮用戶(hù)的接受程度,盡量多的使用圖標、圖表、圖示等簡(jiǎn)潔明快方式去表達,方便客戶(hù)理解。例如,用警告圖標(三角框加一個(gè)“!”),客戶(hù)看到這個(gè)符號,就會(huì )引起注意;用流程圖表來(lái)演示操作過(guò)程,方便客戶(hù)理解前后操作的銜接關(guān)系??諌簷C系統流程圖、電氣原理圖、設備爆炸圖與零部件明細表等圖示,這都是使用說(shuō)明書(shū)里不可或缺的。其中,系統流程圖演示了氣路,水路等流經(jīng)的器件,客戶(hù)可以通過(guò)它了解器件之間的物理關(guān)系,從而有一個(gè)宏觀(guān)的概念。電氣原理圖是用來(lái)表明設備電氣的工作原理及各電器元件的作用,相互之間的關(guān)系的一種表示方式。 運用電氣原理圖,可以方便客戶(hù)分析電氣線(xiàn)路,排除電路故障、程序編寫(xiě)等。
為了使客戶(hù)有一個(gè)良好的閱讀體驗,字體的選擇應嚴謹、簡(jiǎn)潔、耐看。黑體和宋體氣質(zhì)莊重,是很好的選擇。段落、字間距等格式也要斟酌。外文和繁體字使用說(shuō)明書(shū)的要求可參照GB/T 19678標準。
配色方案的選擇也是一個(gè)有講究的方面,一個(gè)設計學(xué)院的學(xué)生學(xué)習配色可能要花兩年的時(shí)間。沒(méi)有經(jīng)過(guò)專(zhuān)業(yè)訓練的人做這件事情是有困難的,做出來(lái)的配色方案會(huì )使人感覺(jué)俗氣。我在這里簡(jiǎn)單說(shuō)一下一些配色經(jīng)驗,首先顏色不要超過(guò)三種,一主兩輔最好,如果公司有主題色,盡量采用,或在商標中取色。其次可以在網(wǎng)上找到優(yōu)秀的配色方案。這里推薦Dribbble網(wǎng)(https:// dribbble.com/),在該網(wǎng)站有很多優(yōu)秀的圖片,而且還非常貼心的給出了配色表,還有一個(gè)配色網(wǎng)(http://www.peise.net/),也有很多優(yōu)秀的配色方案可以拿來(lái)用。
說(shuō)明書(shū)寫(xiě)的太多,客戶(hù)閱讀起來(lái)困難,寫(xiě)的太少,客戶(hù)感覺(jué)你不太重視,所以要權衡,反復錘煉文字。此外,說(shuō)明書(shū)是要批量印制的,一個(gè)錯誤可能會(huì )帶來(lái)非常大的影響,所以要在印制之前仔細校對檢查。
最后,借鑒成熟公司的說(shuō)明書(shū),優(yōu)秀公司的產(chǎn)品說(shuō)明書(shū),都是經(jīng)過(guò)市場(chǎng)檢驗,千錘百煉,有其獨到之處,拿來(lái)參考最好不過(guò)。
參考文獻
GB/T 19678.1-2018/IEC 82079-1:2012 《使用說(shuō)明的編制 構成、內容和表示方法 第一部分:通則和詳細要求》
GB/T9969-2008《工業(yè)產(chǎn)品使用說(shuō)明書(shū) 總則》’;
GB/T10892-2005《固定的空氣壓縮機安全規則和操作規程》
GB22207-2008《容積式空氣壓縮機安全要求》;
HG/T 20206-2017《化工機器安裝工程施工及驗收規范(中小型活塞式壓縮機)(附條文說(shuō)明)》
JB/T 10683-2006《中、高壓往復活塞空氣壓縮機》
JB/T 8933-2008《全無(wú)油潤滑往復活塞空氣壓縮機》
來(lái)源:本站原創(chuàng )

【壓縮機網(wǎng)】企業(yè)每推出一款新產(chǎn)品,壓縮機使用說(shuō)明書(shū)的編寫(xiě)是避免不了的工作任務(wù),本文筆者結合多次撰寫(xiě)說(shuō)明書(shū)的經(jīng)驗,來(lái)分享說(shuō)明書(shū)的編寫(xiě)過(guò)程。
說(shuō)明書(shū)是以應用文體的方式對產(chǎn)品來(lái)進(jìn)行相對詳細的描述,方便人們認識和了解。說(shuō)明書(shū)有指導客戶(hù)使用產(chǎn)品的作用,同時(shí)也是公司的宣傳冊,是與客戶(hù)簽訂的“契約”。凡是客戶(hù)必須知道的地方,說(shuō)明書(shū)中不能遺漏一點(diǎn),從而保證有效指導,提高產(chǎn)品使用的安全、壽命,如若內容不明確,可能會(huì )引起誤會(huì ),甚至招來(lái)糾紛。此外高質(zhì)量的說(shuō)明書(shū)也可以激發(fā)客戶(hù)再次購買(mǎi)的興趣。
編寫(xiě)說(shuō)明書(shū)要有一個(gè)大概的框架??梢园凑誈B/T9969《工業(yè)產(chǎn)品使用說(shuō)明書(shū) 總則》附錄A中提供的標題作為框架,其邏輯性強,不會(huì )產(chǎn)生遺漏。然后對照標題去尋找相應的內容,分列項目、逐項說(shuō)明,各項目明白地羅列出來(lái),使客戶(hù)看的明白。當然,可以根據具體產(chǎn)品的特點(diǎn)和使用要求對標題進(jìn)行增減及合理排序。其中特別要注意的是,使用說(shuō)明書(shū)應提供必要的保護環(huán)境和節約能源方面的內容,不能刪減。這是一種社會(huì )責任和義務(wù),也是標準的要求。
說(shuō)明書(shū)不同于普通的文章,其設計和編寫(xiě)都有規矩,可以參照標準GB/T 19678《使用說(shuō)明的編制 構成、內容和表示方法 第一部分:通則和詳細要求》。標準中規定了設計和編寫(xiě)各類(lèi)使用說(shuō)明的一般原則和詳細要求。作為與客戶(hù)溝通的媒介,使用說(shuō)明書(shū)中相關(guān)信息的描述和細節應通俗易懂,符合壓縮機客戶(hù)群體的知識水平,使用說(shuō)明應遵循客戶(hù)群體的切實(shí)需求,提供充足的細節信息并保證相關(guān)信息的完整性。內容書(shū)寫(xiě)的基本要求和編制方法在標準中也寫(xiě)的很明白,大家可以自行翻閱,這里不再贅述。標準中帶有“應”字段的內容要求在說(shuō)明書(shū)中要體現出來(lái),標準中帶有“宜”字段的內容可以根據自身特點(diǎn)選擇使用。
說(shuō)明書(shū)內容務(wù)必明白、準確才能使讀者完全理解,沒(méi)有含糊、誤會(huì )的弊病。以中壓無(wú)油空壓機使用說(shuō)明書(shū)為例。在動(dòng)手寫(xiě)說(shuō)明書(shū)的時(shí)候,作者心中不能存在一些連自己也理不太清楚的地方,落到紙面不能有一句不合理的,足以發(fā)生疑義的文句。這是一個(gè)消極條件,如果不顧這個(gè)消極條件,寫(xiě)下來(lái)的說(shuō)明書(shū)就達不到它的目的。自己拿不準的,比如性能參數、壽命周期等等這些內容可以向相關(guān)技術(shù)人員請教確認。我們可以按標準列出提綱,請求技術(shù)人員來(lái)協(xié)助完善。另外,說(shuō)明書(shū)的內容還要參考一些專(zhuān)業(yè)標準。GB/T10892-2005《固定的空氣壓縮機安全規則和操作規程》第14~22章有用戶(hù)應履行和遵守的要求,特別是壓縮機的安裝、管道系統和壓縮機的操作要求是客戶(hù)必須掌握的,要在說(shuō)明書(shū)中體現出來(lái)。
GB22207-2008《容積式空氣壓縮機安全要求》中4.4.3超溫停車(chē)裝置靈敏性檢驗,介紹了檢驗方法和次數。5.4使用說(shuō)明,介紹了說(shuō)明書(shū)中必須包含的內容,根據機型可增減;JB/T 10683-2006《中、高壓往復活塞空氣壓縮機》和JB/T 8933-2008《全無(wú)油潤滑往復活塞空氣壓縮機》標準中有關(guān)于保修期、用戶(hù)環(huán)境要求和針對無(wú)油高壓空壓機的專(zhuān)用條款,摘錄出來(lái)寫(xiě)到說(shuō)明書(shū)里。有關(guān)壓縮機環(huán)境保護方面可參照標準GB50894-2013《機械工業(yè)環(huán)境保護設計規范》。法律方面的問(wèn)題,可以在說(shuō)明書(shū)完成初稿后,由法務(wù)審定,特別是售后服務(wù),責任邊界方面要定義清楚,不能含糊。其它機型的產(chǎn)品也有相應的標準要求,一般行業(yè)標準的內容要比國家標準更加詳細,其參照的規范性引用文件也是標準巡查的線(xiàn)索。
GB22207-2008《容積式空氣壓縮機安全要求》中4.4.3超溫停車(chē)裝置靈敏性檢驗,介紹了檢驗方法和次數。5.4使用說(shuō)明,介紹了說(shuō)明書(shū)中必須包含的內容,根據機型可增減;JB/T 10683-2006《中、高壓往復活塞空氣壓縮機》和JB/T 8933-2008《全無(wú)油潤滑往復活塞空氣壓縮機》標準中有關(guān)于保修期、用戶(hù)環(huán)境要求和針對無(wú)油高壓空壓機的專(zhuān)用條款,摘錄出來(lái)寫(xiě)到說(shuō)明書(shū)里。有關(guān)壓縮機環(huán)境保護方面可參照標準GB50894-2013《機械工業(yè)環(huán)境保護設計規范》。法律方面的問(wèn)題,可以在說(shuō)明書(shū)完成初稿后,由法務(wù)審定,特別是售后服務(wù),責任邊界方面要定義清楚,不能含糊。其它機型的產(chǎn)品也有相應的標準要求,一般行業(yè)標準的內容要比國家標準更加詳細,其參照的規范性引用文件也是標準巡查的線(xiàn)索。
說(shuō)明書(shū)要指導用戶(hù)使用產(chǎn)品,就要充分考慮用戶(hù)的接受程度,盡量多的使用圖標、圖表、圖示等簡(jiǎn)潔明快方式去表達,方便客戶(hù)理解。例如,用警告圖標(三角框加一個(gè)“!”),客戶(hù)看到這個(gè)符號,就會(huì )引起注意;用流程圖表來(lái)演示操作過(guò)程,方便客戶(hù)理解前后操作的銜接關(guān)系??諌簷C系統流程圖、電氣原理圖、設備爆炸圖與零部件明細表等圖示,這都是使用說(shuō)明書(shū)里不可或缺的。其中,系統流程圖演示了氣路,水路等流經(jīng)的器件,客戶(hù)可以通過(guò)它了解器件之間的物理關(guān)系,從而有一個(gè)宏觀(guān)的概念。電氣原理圖是用來(lái)表明設備電氣的工作原理及各電器元件的作用,相互之間的關(guān)系的一種表示方式。 運用電氣原理圖,可以方便客戶(hù)分析電氣線(xiàn)路,排除電路故障、程序編寫(xiě)等。
為了使客戶(hù)有一個(gè)良好的閱讀體驗,字體的選擇應嚴謹、簡(jiǎn)潔、耐看。黑體和宋體氣質(zhì)莊重,是很好的選擇。段落、字間距等格式也要斟酌。外文和繁體字使用說(shuō)明書(shū)的要求可參照GB/T 19678標準。
配色方案的選擇也是一個(gè)有講究的方面,一個(gè)設計學(xué)院的學(xué)生學(xué)習配色可能要花兩年的時(shí)間。沒(méi)有經(jīng)過(guò)專(zhuān)業(yè)訓練的人做這件事情是有困難的,做出來(lái)的配色方案會(huì )使人感覺(jué)俗氣。我在這里簡(jiǎn)單說(shuō)一下一些配色經(jīng)驗,首先顏色不要超過(guò)三種,一主兩輔最好,如果公司有主題色,盡量采用,或在商標中取色。其次可以在網(wǎng)上找到優(yōu)秀的配色方案。這里推薦Dribbble網(wǎng)(https:// dribbble.com/),在該網(wǎng)站有很多優(yōu)秀的圖片,而且還非常貼心的給出了配色表,還有一個(gè)配色網(wǎng)(http://www.peise.net/),也有很多優(yōu)秀的配色方案可以拿來(lái)用。
說(shuō)明書(shū)寫(xiě)的太多,客戶(hù)閱讀起來(lái)困難,寫(xiě)的太少,客戶(hù)感覺(jué)你不太重視,所以要權衡,反復錘煉文字。此外,說(shuō)明書(shū)是要批量印制的,一個(gè)錯誤可能會(huì )帶來(lái)非常大的影響,所以要在印制之前仔細校對檢查。
最后,借鑒成熟公司的說(shuō)明書(shū),優(yōu)秀公司的產(chǎn)品說(shuō)明書(shū),都是經(jīng)過(guò)市場(chǎng)檢驗,千錘百煉,有其獨到之處,拿來(lái)參考最好不過(guò)。
參考文獻
GB/T 19678.1-2018/IEC 82079-1:2012 《使用說(shuō)明的編制 構成、內容和表示方法 第一部分:通則和詳細要求》
GB/T9969-2008《工業(yè)產(chǎn)品使用說(shuō)明書(shū) 總則》’;
GB/T10892-2005《固定的空氣壓縮機安全規則和操作規程》
GB22207-2008《容積式空氣壓縮機安全要求》;
HG/T 20206-2017《化工機器安裝工程施工及驗收規范(中小型活塞式壓縮機)(附條文說(shuō)明)》
JB/T 10683-2006《中、高壓往復活塞空氣壓縮機》
JB/T 8933-2008《全無(wú)油潤滑往復活塞空氣壓縮機》

來(lái)源:本站原創(chuàng )


網(wǎng)友評論
條評論
最新評論