Садржај

• На корак
• 1. део од 4: Планирање приручника за власника
• 2. део од 4: Уградити основне информације
• Део 3 од 4: Описивања одржавања производа
• Део 4 од 4: Напишите читљив приручник
• Савети

Софтвер, рачунари, игре и уређаји захтевају корисничке упуте; водичи који објашњавају како користити производ (и како не). Корисничко упутство је формални документ са одређеном структуром и мора га написати неко ко познаје производ изнутра, попут техничког писца или дизајнера производа. За писање ефикасног корисничког приручника потребно је да знате ко ће користити производ и да приручник напишете имајући на уму ове кориснике. Нека ваше писање буде јасно, прецизно и једноставно како бисте осигурали без муке корисничко искуство.

На корак

1. део од 4: Планирање приручника за власника

1. Направите анализу корисника. Корисничко упутство треба да буде написано за кориснике - оне који ће купити ваш производ или услугу и прочитати упутство за употребу. Анализа корисника ће вам рећи ко ће бити ваша главна или циљна публика и водиће вас кроз писање текста.
   • Разговарајте са људима који ће користити ваш уређај. Понудите тест корисницима прототипове уређаја и нацрт корисничког приручника под контролисаним условима. Питајте ове тест кориснике за повратне информације о стварима које су нејасне или збуњујуће у корисничком упутству и на основу ових повратних информација унесите своје корисничко упутство.
   • Никада не можете задовољити читаву своју публику; напишите приручник по мери циљне публике или највеће публике.
   • Узмите у обзир старост, здравље (да ли имају било какве болести, сметње у учењу или сметње у развоју?) И ниво образовања публике да бисте утврдили најбољи приступ писању корисничког приручника.
2. Координирајте дизајн корисничког приручника. Ако сте били део тима који је помогао у дизајнирању и развоју уређаја или производа, може бити тешко објективно погледати производ да бисте објаснили како он функционише. Стога бисте требали потражити савет писца (по могућности некога са искуством у писању упутстава) и графичког дизајнера који ће вам помоћи у припреми корисничког приручника. Те људе можете изабрати путем спољне консултантске службе или из сопствене компаније или организације.
3. Направите анализу задатка. Анализа посла је поступак идентификовања и организовања корака потребних за употребу уређаја. Темељна анализа посла идентификује материјале и опрему (попут батерија, лекова или других производа које испоручује корисник) потребних за сваки корак, као и радње, грешке и савете за решавање проблема који би могли захтевати сваки корак.
   • Ако имате производ који може да извршава много различитих задатака или подзадатака, за сваки задатак морате извршити анализу задатка. На пример: у аутомобилу можете трубити, везати се и укључити или искључити фарове. Направите анализу посла за сваку од њих, ако је потребно.
4. Уверите се да ваш производ испуњава захтеве за означавање и одобрење за стављање у промет. Ови захтеви осигуравају да се производи производе са пажњом корисника и да је изложеност корисника опасним условима, попут зрачења и струјног удара, ограничена. Огласи треба да јасно наводе сврху и основне смернице за рад производа, а ви бисте их требали користити приликом писања корисничког приручника.
   • Да би кориснички приручник за производ био ефикасан, мора бити написан у складу са налепницама залепљеним директно на производ.
   • Пре писања корисничког упутства, уверите се да је ваш уређај званично лиценциран за продају.
5. Одлучите се за изглед вашег приручника. Постоји неколико важних начина на које можете поједноставити свој приручник. На почетку сваког одељка морате ставити подебљани наслов са сваком речју великим словима. На пример, „Подешавање уређаја“, „Управљање уређајем“ и „Решавање проблема“ могу бити подебљани наслови одељака.
   • Други начин за поједностављивање водича је коришћење две колоне, једна с десне стране са текстом, а друга с леве стране текста, са ознакама, бројевима или малим иконама, као што су знакови упозорења или црвени ускличници.
   • Приручник се може састојати углавном од слика са неким текстом испод сваке слике да би се објаснио уређај, или то може бити углавном текст са само неколико пратећих слика. Такође можете да користите дијаграм тока да бисте водили корисника. Размислите о свом производу и како вам свака метода може помоћи да напишете свој приручник. Међутим, избегавајте мешање различитих распореда унутар једног приручника. Изаберите један и држите се њега.

2. део од 4: Уградити основне информације

1. Организујте приручник логично. Приручник треба да буде структуриран на такав начин да ће корисник од њега имати највише користи. Поделите приручник на поглавља или одељке који имају смисла за употребу производа и укључите садржај на челу приручника тако да се сваки одељак може брзо пронаћи.
   • Садржај је посебно потребан за дуже упуте.
   • Појмовник или индекс су неопходни ако постоји много израза који објашњавају да ваша публика можда није упозната. Међутим, речник се не препоручује; најбољи избор је објаснити збуњујуће појмове у самом тексту приручника. Ако одлучите да укључите појмовник, поставите га на предњу страну упутства, одмах иза садржаја.
   • Списак табела или слика је неопходан само ако је у приручнику више од неколико табела или слика.
   • Додатак је потребан за ствари које треба објаснити, али не могу се објаснити негде другде у упутству, јер би то пореметило ток и фокус.
2. Укључите неопходна упозорења. Општа упозорења или информације из предострожности треба да пружају информације о потенцијалним опасностима изазваним неправилном употребом производа, укључујући смрт или озбиљне повреде. Ова упозорења треба ставити на сам предњи део упутства, након насловне странице, тако да их корисник прво види. Конкретна упозорења такође треба да буду укључена у текст приручника непосредно након или непосредно пре него што се предложи потенцијално опасан корак.
   • На пример, опште упозорење за електрични апарат може бити да га не користите када пада киша.
   • Конкретно упутство би могло бити да се побрините да су вам и руке и уређај суви пре него што га прикључите у утичницу.
   • Наведите слике (попут лобање и укрштених костију) или текст друге боје (као што је црвени текст) како бисте упозорење разликовали од осталих упутстава у ИФУ-у и скренули пажњу корисницима на то.
3. Опишите уређај. Ваш опис треба да садржи и писмено објашњење сврхе уређаја и мали графички приказ како уређај изгледа. На слици треба да буду означени и именовани сви прекидачи, дугмад и делови који се могу причврстити у уређају.
4. Дајте упутства за инсталацију. Одељак за инсталацију треба да садржи основне информације о томе како се припремити за употребу производа или уређаја. Ако уређај не може да изгради или постави кућни корисник, то јасно наведите подебљаним насловом на врху одељка за инсталацију. Такође треба да укључите следеће:
   • Листа делова
   • Упутства за распакивање
   • Упозорења о инсталацији
   • Последице нетачне уградње
   • Кога треба позвати у случају потешкоћа током инсталације
5. Наведите информације о операцији. Овај одељак је најважнији део корисничког упутства и треба да пружи конкретне, детаљне информације о начину коришћења уређаја. Почните са основном припремом за употребу јединице, као што је укључивање кабла за напајање или прање руку. Наставите са логичким, нумерисаним корацима који описују како се користи уређај, као и са било којим повратним информацијама (на пример, „Зачућете клик ...“) које корисник може очекивати када правилно користи уређај.
   • На крају овог поглавља, кориснике треба упутити на поглавље о решавању проблема како би решили проблеме који се не могу брзо објаснити.
   • Поставите слике тамо где је потребно. Неке кораке је најбоље објаснити сликама и речима. Размотрите употребу фотографија или илустрација у вашем упутству.
   • У овом одељку, као и у сваком одељку, требали бисте укључити релевантна сигурносна упозорења о неправилној употреби или раду. На пример, можете упозорити кориснике моторне тестере да не пију алкохол или не користе моторну тестеру док су на одређеним лековима.
   • Ако мислите да ће корисници имати користи, размислите о укључивању веза до видео снимака на мрежи који демонстрирају правилну употребу и рад уређаја. Ове видео записе можете снимати на почетку овог одељка или (у случају видео снимака који илуструју само један корак) на крају сваког корака.
6. На крају додајте резиме производа. Сажетак треба да се појави на крају приручника, непосредно пре индекса, како би се пружили основни оперативни кораци. Ово би требало да буде поједностављена, уклоњена верзија оперативних информација и не би требало да има више од једне странице. Резимирајте како ће се уређај или производ користити. Укључите основна упозорења, нумерисане кораке који објашњавају како се користи производ и бројеве телефона или адресе е-поште које кориснике упућују на помоћ.
   • Ако очекујете да ће корисник често уклањати или упућивати на сажети лист, можете га одштампати на уклоњивој ламинираној картици или дебелом картону како бисте га лакше носили и позивали.
   • Алтернативно, резиме можете да примените директно на производ за брзу и једноставну референцу корисника.

Део 3 од 4: Описивања одржавања производа

1. Објасните како се чисти уређај. Ако је вашем уређају или производу потребно чишћење, објасните како се то ради. Наведите потребна средства за чишћење. Реците читаоцу колико често треба да чисти. Затим, као и у било ком другом делу приручника, додајте нумерисана детаљна упутства о томе како га очистити.
   • Ако је за чишћење потребно раставити производ или уклонити одређени део или делове, наведите како производ треба раставити.
   • Дајте упозорење о резултатима неуспешног чишћења уређаја. На пример, можете рећи: „Ако се уређај не очисти, перформансе ће бити мање од оптималне“.
2. Бројте корисника како да изврши основно одржавање. Ако производ или уређај корисник може сервисирати ради исправљања проблема са перформансама, наведите нумерисана упутства како то учинити за корисника. На пример, ако батерије треба заменити након сваких 300 сати употребе, обезбедите упутства о томе како да проверите да ли батерије треба заменити, како уклонити испражњене батерије и како инсталирати нове.
   • Ако постоје одређени задаци одржавања које може да обавља само овлашћени техничар, поделите део приручника за одржавање на два дела.
3. Разговарајте о могућностима складиштења. Ако је потребно, у упутству треба објаснити како правилно складиштити производ или уређај. требали бисте укључити и информације о томе зашто је складиштење неопходно и последице неправилног складиштења. На пример: могли бисте написати:
   • Чувајте производ на хладном и сувом месту. Неправилно складиштење може скратити животни век производа због накупљања влаге. "
   • „Не излажите производ грејању нити га чувајте на температурама вишим од 50 степени Целзијуса.Ако то учините, то може довести до сагоревања “.
4. Наведите информације о решавању проблема. Овај одељак можете организовати као листу најчешћих проблема и њихових решења. Групишите сличне проблеме под логички наслов. На тај начин корисници могу брзо да пронађу одређене проблеме.
   • На пример, ако постоји неколико проблема са рачунаром који приказује плави екран, групишите их у поднаслов, на пример „Уобичајени проблеми на екрану“.
   • У овај одељак такође морате да укључите телефонски број и / или е-пошту за корисничку подршку.

Део 4 од 4: Напишите читљив приручник

1. Прочитајте остала упутства за употребу. Пре писања упутства за сопствени производ, погледајте друге ефикасне корисничке водиче. Обратите пажњу на структуру, избор речи и структуру реченице. Главни брендови као што су Аппле, Гоогле и Мицрософт производе јаке, ефикасне корисничке водиче који вам могу помоћи да израдите промишљеније упутство за употребу.
   • Немојте само читати све упутства за употребу. Прочитајте приручнике за сличне производе које продајете. На пример, ако продајете производе за бебе, прочитајте приручнике за бебе, а не техничке.
2. Изаберите своје стандарде. Стандардизацијом правописа, избора речи и формулација учиниће кориснички приручник лакшим за употребу. Чикашки приручник за стил и Мицрософтов приручник за стил такође могу бити корисни водичи за стил приликом писања корисничког приручника; проверите обоје да ли је један прави за ваш приручник.
   • На пример, уместо да у свом упутству користите и „прекидач за напајање“ и „дугме за напајање“, одаберите један од два израза и придржавајте се тога.
3. Користите активни глас. Активни глас је начин писања који објашњава ствари из перспективе корисника. Лакше је разумети него алтернативу, пасивни глас, у коме субјекат није дефинисан.
   • Испробајте апликацију Хемингваи (ввв.хеммингваиапп.цом) да бисте препознали пасивне пасусе у свом тексту.
   • Проучите ове две узорке реченица - прва је активна, а друга пасивна:
     • Пакет морате отворити полако и пажљиво.
     • Паковање треба отварати полако и пажљиво.
4. Напиши нумерисана упутства. Нумерички поредане упуте помажу читаоцу да се боље усредсреди на процес употребе, повезивања или израде дотичног производа. Уместо да пишете дугачак, опширан одломак или низ небројених одломака, напишите свој кориснички водич једноставним, експлицитним корацима, од којих су сваки јасно нумерисани.
5. Започните сваки корак императивом. Императив је глагол усмерен на радњу. Започињући сваки корак глаголом, читаоцу дајете наговештај о радњи потребној за довршавање корака. На пример, у зависности од производа о којем пишете, кораке можете започети наредбом попут „Повежи се“, „Потврди“ или „Превуци“. Међутим, немојте започињати кораке одговором система.
   • На пример, ако екран постане плав и почне трептати, не започињте корак са: „Екран ће трепнути и постати плав.“ Покушајте: „Притисните и задржите тастер за почетни екран. Екран ће трептати и постаће плав “.
6. Одредите који ћете речник користити. Ако пишете јо-јо приручник, ваша публика ће углавном бити мала деца. Користите једноставне речи и речник да бисте објаснили како јо-јо функционише. Када пишете приручник за скенирајући електронски микроскоп, вашу публику чине високо квалификовани научници који могу да разумеју врло детаљне информације, па немојте избегавати употребу специјализованог речника или нијансираних објашњења.
   • Генерално, трудите се да избегавате жаргон и технички језик.
   • Да бисте били ефикасни за најширу могућу базу корисника, покушајте да пишете на нивоу од шестог до седмог разреда основне школе.
7. Када испоручујете производ у иностранство, уверите се да су ваши преводи тачни. Ангажујте преводиоца да преведе ваше упутство за употребу на матерњи језик земље у коју шаљете производ. Такође можете да користите програм за онлајн превођење, али замолите изворног говорника да прочита превод и провери да ли има грешака.
   • Ако је у вашој публици заступљено више језичких група, укључите преводе корисничког приручника на сваки релевантни језик.
   • Преводилац мора бити упознат са производом, јер у циљном језику могу постојати различите речи за одређене појмове који нису преводи од речи до речи.
8. Напишите у кратким реченицама. Уместо неколико дугих пасуса, користите пуно кратких пасуса. Потражите логичке преломе у сваком одељку и сварите корисне информације у деловима од једне или две реченице. Исто је и на нивоу реченице. Нека ваше реченице буду кратке и једноставне, а не дуге и опширне.
   • Ако корак постаје предуг, поделите га на мање кораке. Ово неће смањити број речи, али преломи редова олакшаће читање.
9. Погледајте приручник за грешке. Приручник може изгубити кредибилитет због граматичких и правописних грешака. Нека колега или технички писац такође уређује и лекторира приручник. Поред правописа и граматике, лектор треба обратити пажњу на следеће:
   • Пасив
   • Нејасан или збуњујући језик
   • Умотана структура реченице
   • Предуго пасуси

Савети

• Људи уче на различите начине; Ако је могуће и прикладно, у приручник укључите визуелна помагала или везе до видео записа на мрежи како бисте примили визуелно оријентисане читаоце.