Како да напишете јасни и концизни кориснички прирачници
Што е упатство за употреба?
Постојат различни имиња за упатство за употреба. Техничките документи, прирачниците за одржување и упатствата се сите имиња што се однесуваат на истата ставка. Упатство за употреба е направено за да им помогне на клиентите правилно да го користат вашиот производ или услуга или да ги решат проблемите што се случуваат за време на употребата. Тие можат да бидат достапни во печатен, дигитален или во двата формати.
Упатствата за употреба му обезбедуваат на крајниот корисник сеопфатни, чекор-по-чекор инструкции и одредена поддршка за проблеми. Содржината треба да биде присутна во секое упатство за употреба бидејќи тие се референтни материјали наместо книги што треба да се читаат од почеток до крај. Треба да додадете упатство за брз почеток или стартување во вашето упатство за користење, така што корисниците лесно ќе се чувствуваат спокојно кога ќе почнат да го користат производот.
видови на прирачници за употреба
За различни теми и цели, може да се изготват кориснички прирачници. Еве некои од вашите можности, па ајде да ги погледнеме.
- Упатство за употреба
Упатството за употреба е тип на упатство за корисникот кое нуди јасни упатства за користење на производот на начинот на кој тој бил наменет да се користи. - Прирачник за обука
Овој вид на упатство за корисникот нуди листа на упатства за завршување на одредена задача, проект или работа. - Сервисен прирачник
Сервисните прирачници се кориснички водичи кои опишуваат како да се грижите и одржувате парче машина или опрема на различни местаtagе од неговиот животен век. - Упатство за употреба
Прирачниците за употреба се технички публикации кои објаснуваат како правилно да се користи или ракува со производот. - Прирачник за работа
Улогите, должностите и процедурите специфични за бизнис или организација се опишани во прирачниците за работа. - Прирачник за организациска политика
Прирачник за организациска политика е документација која ги дефинира политиките, практиките и најдобрите практики на компанијата. - Прирачник за стандардни оперативни процедури (СОП).
Корисниците имаат корист од деталните упатства на прирачникот за стандардни работни процедури за спроведување на утврдените процедури.
Зошто на вашиот бизнис му требаат кориснички прирачници?
Луѓето се подобро опремени сами да се справуваат со проблемите со поддршка на упатство за употреба. Пристоен кориснички прирачник може да им ги даде на вашите клиенти алатките што им се потребни за брзо и ефективно да ја постигнат вредноста што ја посакуваат од вашиот производ или услуга во денешната култура на непосредно задоволување.
Одличната услуга за клиенти треба да се надополни со кориснички прирачници. Пишувањето одлични прирачници за корисникот ќе го обезбеди следниот адванtagе за вашата компанија:
- За да се поедностават вградувањето и обуката
Добро напишаните упатства за корисникот може да ги направат поедноставни процедурите за вклучување и обука. Тоа е точно.
Вашата компанија може да користи кориснички водичи за да им помогне на новите вработувања да поминат низ некои од процесите и системите што се дел од нивните нови улоги, наместо само да поставуваат тешки сесии за обука лично, кои имаат значителни временски и финансиски трошоци. Бидејќи вработените можат да учат додека ги извршуваат должностите поврзани со нивните позиции благодарение на упатствата за корисници, може да има помалку изгубени часови за време на влегувањето. - Да се намалат трошоците за поддршка
Корисничките водичи се одличен додаток на вашите напори за услуги на клиентите за потрошувачот, но тие исто така му служат на сопственикот на бизнисот како компонента на системот за поддршка на клиентите.
Поголема е веројатноста клиентите веднаш да најдат решенија и помала е веројатноста дека ќе треба да контактираат со техничар или претставник за специјализирана поддршка кога ќе им дадете брз пристап до корисничко упатство што може да се пребарува. - За да заштедите време
И вашите клиенти и вашите вработени, од почетниот персонал до раководството, можат да заштедат време со користење на прирачници за корисници. Кога корисничките прирачници се достапни за вашите клиенти, тие нема да мора да губат време обидувајќи се да најдат информации за тоа како да го користат производот, бидејќи веднаш ќе имаат директен пристап до тие информации.
Кога вашите вработени се опремени со корисни прирачници, тие не мора да губат време самостојно да бараат решенија или да го монополизираат вниманието на нивните соработници и менаџери со прашања, бидејќи тие имаат пристап до решенијата директно во нивното упатство за употреба! - Да се минимизира одговорноста
Еден пристап за да покажете дека сте го тестирале вашиот производ темелно и знаете како безбедно да го користите е да пишувате и дистрибуирате прирачници за корисници. Ова може значително да ги намали сите обврски поврзани со производство на нешто за пошироката јавност.
Запишувањето на предупредувањата и безбедносните мерки на претпазливост и достапни за корисниците преку упатството за корисникот е ефикасен (иако не е сигурен) начин за да се избегнат правни проблеми поврзани со повреди или други штети предизвикани од злоупотреба, доколку производот што го продавате може да биде опасен за корисниците (да мислите дека греалки, електрични алати итн.).
Кои компоненти ги сочинуваат најдобрите кориснички прирачници?
Постојат некои најдобри практики за документација за крајниот корисник до кои треба да се придржувате без разлика на се, иако секој производ е уникатен и ќе има потреба од различни компоненти за да се генерира навистина одлична корисничка документација.
- Обичен јазик
Ништо повеќе нема да ги иритира вашите клиенти - освен тоа што нема да понудите - отколку да откриете дека нивното упатство за употреба е преполно со жаргон и тешко разбирлив јазик. Вашите кориснички упатства се тешки за употреба поради овие јазични избори, кои исто така не промовираат извонредна услуга за клиентите. Да се осигурате дека пишувате за корисникот, а не за развивачот, е клучна компонента за создавање одлични кориснички водичи. Не претпоставувајте дека вашиот краен корисник знае или е запознаен со нешто. Акронимите, жаргонот и канцелариската терминологија ќе направат вашите клиенти да се чувствуваат погрешно, фрустрирано и неподготвено. Слаткото место за изработка на упатство за употреба е да се постигне рамнотежа помеѓу тоа да не пишувате како вашите потрошувачи да се деца (освен ако, се разбира, не се!) и да им се даде дополнителна помош што им е потребна за целосно да разберат како да го користат производот, на едноставен јазик. - Едноставност
Пишувањето прирачник за корисници бара нештата да бидат едноставни. Овој концепт треба да се одрази и во содржината и во дизајнот. Ако ја преполните вашата документација со сложени слики и долги делови од текст, таа ќе изгледа премногу софистицирана и тешко разбирлива. Овој вид на упатство за корисникот најверојатно ќе го заплаши вашиот корисник и ќе го наведе да се јави на вашата линија за помош наместо да се обидува самостојно да го открие нивниот проблем. - Визуелни
Максимата „Покажи, не кажувај“ е камен-темелник на пишувањето на прирачникот за корисникот. Прибелешките од екранот, филмовите и другите визуелни содржини се исклучително корисни во разбирањето на концептите. Често е многу покорисно да се види нешто во акција отколку да се чита за тоа. Визуелите не само што ги разбиваат долгите делови од текстот, туку го намалуваат и количеството текст во прирачниците за користење што може да биде страшно. Докажано е дека луѓето ги задржуваат визуелните информации 7% побрзо отколку пишаните информации. Во една студија на Techsmith, исто така, беше покажано дека 67% од луѓето поефикасно ги извршувале задачите кога добивале инструкции кои вклучуваат прибележени слики од екранот, а не само зборови за да пренесат информации. - Фокусирајте се на проблемот што треба да се реши
Многу е веројатно дека некој го купил вашиот производ за да реши некој проблем. Неопходно е да останете фокусирани на ова прашање кога го подготвувате упатството за употреба што ќе биде вклучено со производот. Наместо да ги набројувате и дискутирате сите карактеристики што ги нуди вашиот производ или интригантните елементи на дизајнот што сте ги вградиле, информирајте ги вашите корисници за нив на начин што ќе ја олесни употребата на производот. Поставете го проблемот што се решава во контекст на карактеристиките и придобивките на вашиот производ кога ги опишувате. - Логички тек и хиерархија
За да му стане јасно на корисникот што ќе научи од секој дел од вашето упатство за употреба, користете заглавија и поднаслови кои следат јасна хиерархиска структура. Со цел без напор да ги водите вашите клиенти низ сè што треба да знаат од почеток до заклучок, хиерархијата што ќе ја изберете треба да следи логичен тек. Погрижете се да започнете со основите и да вклучите логична прогресија кон пософистицираните карактеристики на вашиот производ. - Список со содржини
Вашето корисничко упатство ќе им биде најкорисно на читателите ако започне со табела со содржина. Без потреба да се копа низ многу страници со информации кои не се поврзани со тековниот проблем со кој се соочуваат, познат пристап е некој брзо и лесно да истражува документ. - Направете го да може да се пребарува
Дури и ако можете да ги испечатите вашите прирачници за користење, веројатно е дека дигиталната документација ќе ви биде главен приоритет. Сосема е веројатно дека вашите прирачници за употреба ќе се користат најчесто во дигитален формат во свет каде што повеќето луѓе имаат паметен телефон со себе во секое време. Додавањето функција за пребарување во вашите дигитални кориснички прирачници ќе промовира прекрасна леснотија на користење за корисниците кои сакаат да решат проблем со пристап до него, слично на тоа како табелата со содржини служи за да ги насочи корисниците на соодветното место во печатениот документ. - Пристапност
Можно е некои од луѓето на кои им е потребно вашето упатство за употреба да имаат корист од дополнителна помош за да се осигураат дека тој функционира правилно. Без оглед на тоа дали тие се задолжителни со закон, барањата за пристапност се генерално добра практика. Одржувањето на барањата за пристапност во вашите кориснички прирачници е само одлична деловна практика. Дизајнирањето на кориснички водичи со содржина што е достапна за корисници кои би можеле да имаат визуелни, звучни или когнитивни предизвици е од клучно значење. - Добро дизајниран
Размислете за вашата публика кога ги креирате вашите кориснички водичи. Тие ќе бидат многу посклони да го користат ефективно ако направите нешто во што уживаат да гледаат! Избегнувајте користење на долги текстуални блокови и обезбедете многу бел простор. Комбинирањето на овие две карактеристики може да им помогне на потрошувачите да изгледаат помалку застрашувачки и да направат учењето нешто ново да изгледа возбудливо наместо заканувачко. Пристапот „покажи, не кажувај“ што го опишавме претходно, исто така важи и овде. И за печатените и за дигиталните кориснички прирачници, додавањето визуелни и фотографии на текстот е одлична алтернатива. За дигиталните кориснички прирачници, видеата и GIF-овите нудат интерес и корисен елемент. Ако вашата компанија има водич за стил, вашиот дизајн треба да го следи; во спротивно, ако работите без таков, од клучно значење е да го одржувате вашето упатство за корисникот конзистентно. Фонтот и шемите на бои што се користат низ хартијата, и идеално во сите ваши упатства за користење, треба да бидат конзистентни. - Коментари од вистински клиенти или бета тестери
Нема да можете да одредите дали упатствата за корисници што сте ги подготвиле се колку што е можно поуспешни додека не побарате и слушате повратни информации од луѓето кои всушност ќе го користат вашиот производ. Упатствата за корисници што ги развивате за вашиот производ треба да ги земат предвид проблемите што луѓето ги имаат со него. Можеби ќе научите нешто што изгледа исклучително очигледно, но има многу поголеми шанси да научите нешто што ќе ви помогне да ги разберете потребите на клиентите што се обидувате да ги достигнете.
Како да напишам упатство за употреба?
Изработката на упатство за корисникот е клучна задача која може да има големо влијание и на вашата компанија и на потрошувачите на кои сакате да им служите. Го поедноставивме процесот на развивање упатство за корисникот за да можете лесно да го следите затоа што може да биде огромно.
- Идентификувајте ги корисниците
Пронаоѓањето на примачот на вашата комуникација е суштински почетен чекор, исто како и со секоја друга комуникација што ја создавате. Целната публика на вашето упатство за корисник ќе ви помогне да одлучувате за прашања како тонот, нивото на детали што треба да ги обезбедите и како да ја испорачате содржината. Пишувањето упатство за корисникот за крајниот корисник на вашиот производ е значително различно од пишувањето упатство за технички инженер. Првиот чекор е да ја одредите вашата публика. - Фокусирајте се на проблемот
Прирачниците за користење се направени за да помогнат во решавањето на проблемите или да упатат некого како да направи нешто ново. Мора прецизно да одредите што е наменето вашето упатство за употреба и да се погрижите да го задржите тој фокус.
Може да биде примамливо да ја проширите темата и да разговарате за бројни карактеристики или апликации за вашиот производ. Ова може да ги фрустрира корисниците и да доведе до повици до вашата линија за поддршка на клиенти со замаглување на вистинскиот одговор што тие го бараат.
Ако вашиот клиент е потрошувач кој учи како да го користи производот или техничар кој треба да го поправи, концентрирајте се на прецизното решение што ќе го бараат. - Примени секвенцијален пристап
Упатствата во вашето упатство за употреба треба да бидат поставени по редослед што е неопходен за да се заврши работата. Наведете го секој чекор за да започнете. Потоа, потрудете се да ја извршите задачата додека се придржувате до прецизните чекори што сте ги навеле во дадениот редослед. Како што поминувате низ вашата оригинална листа, можно е, можеби дури и веројатно, да најдете какви било stagшто недостасуваат. Дополнително, може да откриете дека нешто за кое некогаш верувавте дека е единствена задача, всушност треба да се подели на неколку активности заради јасност.
Осигурајте се дека сте навеле јасен исход за секој последователен чекор што сте го доделиле пред да преминете на следната фаза на пишување упатство за корисникот. Пред да преминат на следното ниво, на читателите треба да им биде сосема јасно што сакаат да се постигне и како треба да изгледа. - Патување на корисникот на мапата
Разбирањето како вашите потрошувачи планираат да го користат вашиот производ и да им го олеснат тоа се целите на изработка на упатство за корисникот. Мора да вложите напори да го разберете проблемот што потрошувачот се обидува да го реши или целта што се обидува да ја постигне со користење на вашето решение, како и како тие се ангажираат со вашиот бизнис. Можете да ги планирате чекорите неопходни за да го водите клиентот низ процесот користејќи ги овие детали за да го визуелизирате нивното патување од проблем до решение. - Изберете Шаблон
Задачата за пишување и развивање на кориснички прирачници може да се направи многу поедноставна отколку што може да очекувате со креирање на серија шаблони. Вашата процедура може да биде рационализирана, а конзистентноста би станала многу пореална цел.
Во шаблонот за упатство за корисникот, покрај дефинирањето на детали како фонтови (тип и големина), барања за контраст и шеми на бои, треба да го вклучите и следново:- Површина доделена за вовед
- Различни подсекции и делови
- Вашиот избран формат за пренесување низа дејства
- Забелешки за претпазливост и предупредувања
- Површина доделена за заклучок
- Напишете едноставна и лесна за следење содржина
Материјалот на вашето упатство за употреба треба да биде што е можно поедноставен и едноставен за разбирање. Важно е да се размислува и да се анализира форматот и содржината за јасност и погодност.
Погрижете се секоја фаза од процесот да прикажува само една задача и да користи што е можно појасен и краток јазик. Погрижете се правилно да го модифицирате вашиот текст додека не добиете упатство за употреба што ги содржи само информациите што се навистина неопходни. - Пристапете кон секој корисник како почетник
Претпоставете дека читателот на вашето упатство за употреба нема претходно познавање за вашиот производ при неговото креирање. Пишувајте како да зборувате со лаик.
Треба да се избегнува секаква употреба на жаргон или технички јазик. Секако, ќе има моменти кога тоа мора да се избегнува, но тие треба да бидат апсолутен исклучок. - Тестирајте ги упатствата на производот со почетниците корисници
Фазата на тестирање на процесот на креирање на прирачникот за корисникот е клучна. Предметот на експериментот има значително влијание врз исходот.
Тестирањето идеално треба да се направи на луѓе кои никогаш не го користеле вашиот производ или ја виделе документацијата. Додека се движите низ упатството за употреба, гледајте ги додека го завршуваат процесот и снимајте каде заглавуваат. Потоа, информациите треба соодветно да се ажурираат.
Само помошта од упатството за употреба треба да биде неопходна за вашите тестери да работат со производот. Тие не треба да бараат повеќе помош. Водичот на СССР треба да ги има сите информации што им се потребни. - Изградете содржина користејќи практичен пристап
Треба да се вложат сите напори за да се понуди конкретни прampле и детални описи на какви било резултати што може да ги искусат корисниците откако ќе го следат секој чекор во упатството за корисникот. Корисникот треба да биде свесен за какви било повратни информации што може да ги добие од производот, како и за сите потенцијални глетки или звуци што би можеле да ги сретнат на патот. - Рано објаснете ги симболите, иконите и кодовите
Можеби ќе треба да користите икони, симболи или шифри додека пишувате упатство за корисникот за да помогнете во обезбедувањето на потребните инструкции. Со цел да се спречи конфузија или фрустрација кај читателот, од клучно значење е да ги идентификувате што е можно порано во вашето упатство за употреба.
Упатство за употреба ЧПП
Што точно е упатството за употреба?
Корисничката документација е информација обезбедена во форма на кориснички прирачници или упатства за корисникот и е наменета да им помогне на крајните корисници успешно да комуницираат со производот.
- Какви видови на корисничка документација постојат?
Физичката документација, како што се брошури или прирачници, традиционално се користи за да се понуди корисничка документација. Деновиве, корисничките прирачници се произведуваат и дистрибуираат почесто дигитално. - Што е содржано во упатството за употреба?
Упатството за употреба или упатството за корисникот користи добар дизајн, јасно пишување и фокус за решавање проблеми. Морам да имам табела со содржини, да се придржувам до логичка хиерархија и тек и да понудам содржина што е достапна. Дополнително, доброто упатство за корисникот ќе може да се пребарува и ќе го земе предвид корисничкиот реviews. - Како се прави кориснички документ?
Може да се користат едноставни чекори за да се развијат кориснички прирачници. Прво мора да се утврдат целите на упатството за корисници и да се развие стратегија за да се овозможи нивно остварување. Упатството за употреба мора да се тестира и ажурира по потреба пред да биде објавено. Конечно, важно е да го ажурирате упатството за корисникот, правејќи промени како што се додаваат нови ажурирања или изданија.