Задаволены

• Крок
• Частка 1 з 4: Планаванне кіраўніцтва вашага ўладальніка
• Частка 2 з 4: Убудаваць неабходную інфармацыю
• Частка 3 з 4: Апісанне абслугоўвання прадукту
• Частка 4 з 4: Напішыце зручны для чытання дапаможнік
• Парады

Праграмнае забеспячэнне, камп'ютэры, гульні і прылады патрабуюць кіраўніцтва карыстальніка; кіраўніцтва, якое тлумачыць, як карыстацца прадуктам (і як нельга). Кіраўніцтва карыстальніка - гэта афіцыйны дакумент з пэўнай структурай, які павінен быць напісаны тым, хто ведае прадукт навыварат, напрыклад, тэхнічным аўтарам альбо дызайнерам прадукту. Для напісання эфектыўнага кіраўніцтва неабходна ведаць, хто будзе карыстацца прадуктам, і пісаць кіраўніцтва з улікам гэтых карыстальнікаў. Трымайце напісанне дакладна, дакладна і проста, каб забяспечыць зручнасць карыстання.

Крок

Частка 1 з 4: Планаванне кіраўніцтва вашага ўладальніка

1. Зрабіце аналіз карыстальніка. Кіраўніцтва карыстальніка павінна быць напісана для карыстальнікаў - тых, хто купіць ваш прадукт ці паслугу і прачытае кіраўніцтва карыстальніка. Аналіз карыстальнікаў скажа вам, кім будзе ваша асноўная ці мэтавая аўдыторыя, і правядзе вас праз напісанне тэксту.
   • Пагаворыце з людзьмі, якія будуць выкарыстоўваць вашу прыладу. Прапануйце тэставым карыстальнікам прататыпы прылады і праект кіраўніцтва карыстальніка ў кантраляваных умовах. Папытаеце гэтых тэставых карыстальнікаў пра водгукі пра незразумелыя і незразумелыя рэчы ў кіраўніцтве карыстальніка і ўнясіце змены ў сваё кіраўніцтва для карыстальнікаў на аснове гэтых водгукаў.
   • Вы ніколі не можаце задаволіць усю сваю аўдыторыю; напісаць дапаможнік з улікам мэтавай аўдыторыі альбо самай вялікай аўдыторыі.
   • Улічвайце ўзрост, стан здароўя (ці ёсць у іх якія-небудзь хваробы, праблемы з навучаннем ці інваліднасць?) І ўзровень адукацыі аўдыторыі, каб вызначыць найлепшы падыход да напісання кіраўніцтва карыстальніка.
2. Узгадніць дызайн кіраўніцтва карыстальніка. Калі вы ўдзельнічалі ў камандзе, якая дапамагала распрацоўваць і распрацоўваць прыладу альбо выраб, можа быць цяжка аб'ектыўна паглядзець на прадукт, каб растлумачыць, як ён працуе. Таму вам варта звярнуцца па кансультацыю да пісьменніка (пажадана, да таго, хто мае вопыт напісання інструкцый) і графічнага дызайнера, які дапаможа вам падрыхтаваць кіраўніцтва карыстальніка. Вы можаце выбраць гэтых людзей з дапамогай знешняй кансультацыі альбо ў вашай кампаніі ці арганізацыі.
3. Зрабіце аналіз задачы. Аналіз працы - гэта працэс выяўлення і арганізацыі этапаў, неабходных для выкарыстання прылады. Падрабязны аналіз працы вызначае матэрыялы і абсталяванне (напрыклад, батарэі, лекі ці іншыя прадукты, якія пастаўляюцца карыстальнікам), неабходныя для кожнага этапу, а таксама дзеянні, памылкі і парады па ліквідацыі непаладак, якія могуць спатрэбіцца на кожным этапе.
   • Калі ў вас ёсць прадукт, які можа выконваць мноства розных задач або падзадач, вы павінны выканаць аналіз заданняў для кожнай задачы. Напрыклад: у машыне вы можаце сагнаць, прывязаць сябе і ўключыць або выключыць фары. Пры неабходнасці зрабіце аналіз працы для кожнага з іх.
4. Пераканайцеся, што ваш прадукт адпавядае патрабаванням маркіроўкі і дазволу на збыт. Гэтыя патрабаванні гарантуюць, што вырабы вырабляюцца з улікам бяспекі карыстальніка і што ўздзеянне карыстальніка на небяспечныя ўмовы, такія як радыяцыя і электратраўма, абмежавана. У рэкламе павінна быць дакладна пазначана прызначэнне і асноўныя рэкамендацыі па эксплуатацыі тавару, і вы павінны выкарыстоўваць гэтыя рэсурсы пры напісанні кіраўніцтва вашага ўладальніка.
   • Каб кіраўніцтва карыстальніка прадукту было эфектыўным, яно павінна быць напісана ў адпаведнасці з этыкеткамі, нанесенымі непасрэдна на прадукт.
   • Перад напісаннем кіраўніцтва карыстальніка пераканайцеся, што ваша прылада мае афіцыйную ліцэнзію на продаж.
5. Вызначыцеся з макетам вашага кіраўніцтва. Ёсць некалькі важных спосабаў, як вы можаце ўпарадкаваць сваё кіраўніцтва. У пачатку кожнага раздзела вы павінны паставіць тлусты загаловак з кожным словам з вялікай літары. Напрыклад, "Налада прылады", "Кіраванне прыладай" і "Пошук непаладак" могуць быць вылучаны тлустым загалоўкам раздзелаў.
   • Іншы спосаб упарадкаваць кіраўніцтва - выкарыстанне двух слупкоў, адзін справа з тэкстам, а другі злева ад тэксту, з маркіроўкамі, лічбамі ці маленькімі значкамі, напрыклад, папераджальнымі знакамі альбо чырвонымі клічнікамі.
   • Кіраўніцтва можа складацца ў асноўным з малюнкаў, у якіх пад кожным малюнкам знаходзіцца тэкст для тлумачэння прылады, альбо гэта можа быць у асноўным тэкст, у якім ёсць толькі некалькі суправаджальных малюнкаў. Вы таксама можаце выкарыстоўваць блок-схему, каб накіроўваць карыстальніка. Падумайце пра свой прадукт і пра тое, як кожны спосаб можа дапамагчы вам напісаць кіраўніцтва. Аднак пазбягайце змешвання розных макетаў у межах аднаго кіраўніцтва. Выберыце адзін і прытрымвайцеся яго.

Частка 2 з 4: Убудаваць неабходную інфармацыю

1. Арганізуйце дапаможнік лагічна. Кіраўніцтва павінна быць пабудавана такім чынам, каб карыстальнік мог атрымаць ад гэтага найбольшую карысць. Падзяліце кіраўніцтва на кіраўнікі або раздзелы, якія маюць сэнс для выкарыстання прадукту, і ўключыце змест у пярэдняй частцы кіраўніцтва, каб кожны раздзел можна было хутка знайсці.
   • Змест асабліва неабходны для больш доўгіх дапаможнікаў.
   • Слоўнік або паказальнік патрэбны, калі ёсць шмат тэрмінаў, якія тлумачаць, што ваша аўдыторыя можа быць не знаёмая. Аднак гласарый не рэкамендуецца; лепшы выбар - растлумачыць заблытаныя тэрміны ў самім тэксце дапаможніка. Калі вы вырашыце ўключыць гласарый, змесціце яго ў пярэдняй частцы кіраўніцтва, адразу пасля зместу.
   • Спіс табліц ці малюнкаў неабходны толькі ў тым выпадку, калі ў кіраўніцтве больш за некалькі табліц ці малюнкаў.
   • Дадатак неабходны для рэчаў, якія трэба растлумачыць, але нельга растлумачыць у іншым месцы ў кіраўніцтве, бо гэта можа парушыць плынь і фокус.
2. Уключыце неабходныя папярэджанні. Агульныя папярэджанні або інфармацыя аб засцярозе павінны прадастаўляць інфармацыю пра магчымую небяспеку, выкліканую няправільным выкарыстаннем прадукту, уключаючы смерць або сур'ёзныя траўмы. Гэтыя папярэджанні павінны быць размешчаны ў самым раздзеле кіраўніцтва, пасля першай старонкі, каб карыстальнік бачыў іх першым. Канкрэтныя папярэджанні таксама павінны быць уключаны ў тэкст дапаможніка непасрэдна пасля таго, як будзе прапанаваны патэнцыяльна небяспечны крок.
   • Напрыклад, агульным папярэджаннем для электрапрыбора можа быць не выкарыстоўваць яго, калі ідзе дождж.
   • Канкрэтнай інструкцыяй можа быць пераканаўшыся, што і вашы рукі, і прылада сухія, перш чым падключаць прыладу да разеткі.
   • Пакажыце выявы (напрыклад, чэрап і скрыжаваныя косці) альбо тэкст іншага колеру (напрыклад, чырвоны тэкст), каб адрозніць папярэджанне ад астатніх указанняў у IFU і прыцягнуць увагу карыстальнікаў да яго.
3. Апішыце прыладу. Ваша апісанне павінна ўключаць як пісьмовае тлумачэнне прызначэння прылады, так і невялікі графічны малюнак таго, як выглядае прылада. На малюнку павінны быць пазначаны і названы ўсе перамыкачы, кнопкі і мацавальныя дэталі, якія змяшчаюцца ў прыладзе.
4. Падайце інструкцыі па ўсталёўцы. Раздзел усталёўкі павінен утрымліваць асноўную інфармацыю пра тое, як падрыхтавацца да выкарыстання прадукта ці прылады. Калі прыбор не можа быць пабудаваны альбо наладжаны хатнім карыстальнікам, укажыце гэта выразна тлустым загалоўкам уверсе раздзела ўстаноўкі. Вы таксама павінны ўключыць наступнае:
   • Спіс дэталяў
   • Інструкцыя па распакаванні
   • Папярэджанні аб усталёўцы
   • Наступствы няправільнай ўстаноўкі
   • Каму патэлефанаваць у выпадку цяжкасцей падчас мантажу
5. Падайце інфармацыю пра аперацыю. Гэты раздзел з'яўляецца найбольш важнай часткай кіраўніцтва карыстальніка і павінен змяшчаць канкрэтную, падрабязную інфармацыю пра тое, як карыстацца прыладай. Пачніце з асноўнай падрыхтоўкі да выкарыстання прылады, напрыклад, падключэння шнура харчавання або мыцця рук. Працягвайце лагічныя пранумараваныя этапы, якія апісваюць, як карыстацца прыладай, а таксама любыя водгукі (напрыклад, "Вы пачуеце пстрычку ..."), якіх карыстальнік можа чакаць пры правільным выкарыстанні прылады.
   • У канцы гэтага раздзела карыстальнікі павінны звярнуцца да раздзела па ліквідацыі непаладак, каб вырашыць праблемы, якія нельга хутка растлумачыць.
   • Размясціце малюнкі там, дзе гэта неабходна. Некаторыя этапы лепш растлумачыць малюнкамі і словамі. Разгледзім выкарыстанне фотаздымкаў ці ілюстрацый у сваім кіраўніцтве.
   • У гэты раздзел, як і ў любы раздзел, вы павінны ўключыць адпаведныя папярэджанні аб бяспецы пры неналежным выкарыстанні і эксплуатацыі. Напрыклад, вы можаце папярэдзіць карыстальнікаў бензапілы, каб яны не ўжывалі алкаголь і не ўжывалі бензапілу падчас прыёму некаторых лекаў.
   • Калі вы лічыце, што карыстальнікі выйграюць, разгледзьце магчымасць уключэння спасылак на відэа ў Інтэрнэце, якія дэманструюць правільнае выкарыстанне і эксплуатацыю прылады. Вы можаце запісваць гэтыя відэа альбо ў пачатку гэтага раздзела, альбо (у выпадку з відэа, якія ілюструюць толькі адзін этап) у канцы кожнага этапу.
6. Уключыце рэзюмэ прадукту ў канцы. Рэзюмэ павінна з'явіцца ў канцы кіраўніцтва, непасрэдна перад індэксам, каб даць асноўныя этапы працы. Гэта павінна быць спрошчаная, знятая версія аператыўнай інфармацыі і павінна складаць не больш за адну старонку. Падагульніце, як трэба выкарыстоўваць прыладу ці выраб. Уключыце асноўныя папярэджанні, пранумараваныя крокі, якія тлумачаць, як карыстацца прадуктам, а таксама нумары тэлефонаў альбо адрасы электроннай пошты, якія накіроўваюць карыстальнікаў на дапамогу.
   • Калі вы чакаеце, што карыстальнік будзе часта выдаляць альбо спасылацца на зводны ліст, вы можаце раздрукаваць яго на здымнай ламінаванай карце або шчыльным кардоне, каб карыстальніку было зручней пераносіць і спасылацца на яго.
   • Акрамя таго, вы можаце ўжыць рэзюмэ непасрэдна да прадукту для хуткага і простага карыстацкага звароту.

Частка 3 з 4: Апісанне абслугоўвання прадукту

1. Растлумачце, як чысціць прыладу. Калі ваша прылада або выраб маюць патрэбу ў ачыстцы, растлумачце, як гэта зрабіць. Пералічыце неабходныя чысцяць сродкі. Раскажыце чытачу, як часта трэба чысціць. Затым, як і ў любой іншай частцы кіраўніцтва, уключыце пранумараваныя пакрокавыя інструкцыі па яго ачыстцы.
   • Калі для чысткі патрабуецца разабраць выраб альбо выдаліць пэўную дэталь альбо дэталі, пакажыце, як выраб трэба разабраць.
   • Дайце папярэджанне аб выніках няўдалай чысткі прылады. Напрыклад, вы маглі б сказаць: "Калі прылада не чысціцца, прадукцыйнасць будзе менш аптымальнай".
2. Падлічыце карыстальніку, як выканаць асноўнае тэхнічнае абслугоўванне. Калі прадукт ці прылада могуць быць скарыстаны карыстальнікам для выпраўлення праблем з прадукцыйнасцю, прадастаўце пранумараваныя інструкцыі, як гэта зрабіць для карыстальніка. Напрыклад, калі батарэі патрабуецца замяняць праз кожныя 300 гадзін выкарыстання, прадастаўце інструкцыі, як праверыць, ці трэба батарэі замяняць, як выдаліць сапсаваныя батарэі і як усталяваць новыя.
   • Калі ёсць пэўныя задачы па тэхнічным абслугоўванні, якія можа выканаць толькі сертыфікаваны тэхнік, падзяліце частку тэхнічнага абслугоўвання на дзве часткі.
3. Абмяркуйце варыянты захоўвання. Пры неабходнасці ў кіраўніцтве павінна быць растлумачана, як правільна захоўваць выраб або прыладу. вы таксама павінны ўключыць інфармацыю пра тое, чаму неабходна захоўванне, і пра наступствы неналежнага захоўвання. Напрыклад: вы можаце напісаць:
   • Захоўваць сродак у прахалодным, сухім месцы. Няправільнае захоўванне можа скараціць тэрмін службы вашага вырабу з-за назапашвання вільгаці ".
   • "Не падвяргайце прадукт нагрэву і не захоўвайце яго пры тэмпературы вышэй за 50 градусаў Цэльсія.Калі вы гэта зробіце, гэта можа прывесці да гарэння ".
4. Падайце інфармацыю аб ліквідацыі непаладак. Вы можаце арганізаваць гэты раздзел як спіс агульных праблем і іх рашэння. Згрупуйце падобныя праблемы пад лагічны загаловак. Такім чынам, карыстальнікі могуць хутка знайсці пэўныя праблемы.
   • Напрыклад, калі ёсць некалькі праблем з камп'ютэрам, які адлюстроўвае сіні экран, згрупуйце іх у падзагаловак, напрыклад "Агульныя праблемы з экранам".
   • Вы таксама павінны ўключыць нумар тэлефона і / або электронную пошту для абслугоўвання кліентаў у гэтым раздзеле.

Частка 4 з 4: Напішыце зручны для чытання дапаможнік

1. Прачытайце іншыя кіраўніцтва карыстальніка. Перш чым пісаць кіраўніцтва для ўласнага прадукту, азнаёмцеся з іншымі эфектыўнымі кіраўніцтвамі карыстальніка. Звярніце ўвагу на структуру, выбар слова і структуру сказа. Асноўныя брэнды, такія як Apple, Google і Microsoft, вырабляюць моцныя, эфектыўныя кіраўніцтвы карыстальнікаў, якія могуць дапамагчы вам стварыць больш прадуманае кіраўніцтва.
   • Не проста чытаць усе кіраўніцтва карыстальніка. Прачытайце кіраўніцтва па аналагічных таварах, якія вы прадаеце. Напрыклад, калі вы прадаеце дзіцячыя тавары, чытайце інструкцыі для дзяцей, а не тэхнічныя.
2. Выберыце свае стандарты. Стандартызацыя правапісу, выбару слоў і фармулёвак зробіць кіраўніцтва карыстальніка больш зручным. Чыкагскае кіраўніцтва па стылі і Кіраўніцтва па стылі Microsoft таксама могуць быць карыснымі дапаможнікамі па стылістыцы пры напісанні кіраўніцтва вашага ўладальніка; праверце абодва, каб пераканацца, што адзін падыходзіць для вашага кіраўніцтва.
   • Напрыклад, замест таго, каб у сваім кіраўніцтве выкарыстоўваць "перамыкач харчавання" і "кнопку харчавання", выберыце адзін з двух тэрмінаў і прытрымвайцеся яго.
3. Выкарыстоўвайце актыўны голас. Актыўны голас - гэта спосаб напісання, які тлумачыць рэчы з пункту гледжання карыстальніка. Гэта зразумець прасцей, чым альтэрнатыву, пасіўны голас, у якім суб'ект не вызначаны.
   • Паспрабуйце прыкладанне Hemingway (www.hemmingwayapp.com), каб вызначыць пасіўныя ўрыўкі ў сваім напісанні.
   • Вывучыце гэтыя два ўзоры прапаноў - першы актыўны, а другі пасіўны:
     • Вы павінны адкрываць пакет павольна і асцярожна.
     • Упакоўку трэба адкрываць павольна і асцярожна.
4. Напішы пранумараваныя інструкцыі. Інструкцыі з лічбавым упарадкаваннем дапамагаюць чытачу лепш засяродзіцца на працэсе выкарыстання, падключэння або стварэння разгляданага прадукту. Замест таго, каб пісаць доўгі шматслоўны абзац альбо шэраг ненумараваных абзацаў, напішыце сваё кіраўніцтва карыстальніка з простымі, відавочнымі крокамі, кожны з якіх дакладна пранумараваны.
5. Пачынайце кожны крок з імператыву. Імператыў - дзеяслоў, арыентаваны на дзеянне. Пачынаючы кожны крок з дзеяслова, вы даяце чытачу падказку пра дзеянне, неабходнае для завяршэння этапа. Напрыклад, у залежнасці ад прадукту, пра які вы пішаце, вы можаце пачаць свае крокі з такой каманды, як "Падключыцца", "Пацвердзіць" альбо "Слайд". Аднак не пачынайце свае крокі з адказу сістэмы.
   • Напрыклад, калі экран становіцца сінім і пачынае міргаць, не пачынайце крок з: "Экран будзе міргаць і сінець". Паспрабуйце: "Націсніце і ўтрымлівайце клавішу" Дадому ". Экран будзе міргаць і сінець ".
6. Вызначце, які слоўнікавы запас вы будзеце выкарыстоўваць. Калі вы пішаце дапаможнік па ё-ё, вашай аўдыторыяй будуць у асноўным маленькія дзеці. Выкарыстоўвайце простыя словы і слоўнікавы запас, каб растлумачыць, як працуе ё-ё. Калі вы пішаце дапаможнік па сканіруючым электронным мікраскопе, ваша аўдыторыя складаецца з высокакваліфікаваных навукоўцаў, якія могуць разумець вельмі падрабязную інфармацыю, таму не цурайцеся выкарыстання спецыялізаванай лексікі ці нюансных тлумачэнняў.
   • Увогуле, вы стараецеся пазбягаць жаргону і тэхнічнай мовы.
   • Паспрабуйце пісаць на ўзроўні з шостага па сёмы клас пачатковай школы, каб быць эфектыўным для максімальна шырокай базы карыстальнікаў.
7. Перасылаючы прадукт за мяжу, пераканайцеся, што пераклады дакладна. Найміце перакладчыка, каб перакласці ваша кіраўніцтва карыстальніка на родную мову краіны, у якую вы адпраўляеце прадукт. Вы таксама можаце выкарыстоўваць Інтэрнэт-праграму перакладу, але папытаеце носьбіта мовы прачытаць пераклад і праверыць наяўнасць памылак.
   • Калі ў вашай аўдыторыі прадстаўлена некалькі моўных груп, уключыце пераклады кіраўніцтва карыстальніка на кожную адпаведную мову.
   • Перакладчык павінен быць добра знаёмы з прадуктам, бо ў мове перакладу могуць быць розныя словы для пэўных тэрмінаў, якія не з'яўляюцца перакладам "слова ў слова".
8. Запішыце кароткімі сказамі. Замест некалькіх доўгіх абзацаў вы выкарыстоўваеце шмат кароткіх абзацаў. Шукайце лагічныя разрывы ў кожным раздзеле і пераварвайце карысную інфармацыю кавалкамі ў адзін ці два сказы. Тое самае і на ўзроўні сказа. Сказы павінны быць кароткімі і простымі, а не доўгімі і шматслоўнымі.
   • Калі крок становіцца занадта доўгім, разбіце яго на больш дробныя крокі. Гэта не паменшыць колькасць слоў, але разрывы радкоў палегчаць чытанне.
9. Праверце кіраўніцтва на наяўнасць памылак. Дапаможнік можа страціць давер з-за граматычных і арфаграфічных памылак. Папрасіце калегу альбо тэхнічнага пісьменніка адрэдагаваць і вычытаць кіраўніцтва. Акрамя правапісу і граматыкі, карэктар павінен звярнуць увагу на наступнае:
   • Пасіўны голас
   • Незразумелая альбо заблытаная мова
   • Абгорнутая структура сказа
   • Занадта доўгія абзацы

Парады

• Людзі вучацца па-рознаму; Калі магчыма і дарэчы, уключыце ў дапаможнік візуальныя дапаможнікі альбо спасылкі на відэа ў Інтэрнэце для размяшчэння чытачоў, арыентаваных на зрок.