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