Използвайте този шаблон
Страхотното ръководство за потребителя на софтуер е по-кратко, по-остро и по-фокусирано върху задачите, отколкото пълното ръководство — и често е по-полезно. С Trupeer можете да спестите часове при създаването на ръководства за потребителя, като започнете с безплатен шаблон за ръководство за потребителя, персонализирате го с вашите brand guidelines и използвате нашия AI manual creator, за да превърнете обиколките на продукта в ангажиращи видео ръководства.
Какво е безплатен шаблон за ръководство за потребителя на софтуер?
Безплатният шаблон за ръководство за потребителя на софтуер е повторяемa структура за документацията, която четат крайните ви потребители: как да правят нещата, за които е софтуерът, написани за човека, който го използва, а не за човека, който го изгражда или управлява.
Той е един член от по-голямо семейство. Референтната документация, архитектурните записи, оперативните runbooks и release notes обслужват различни аудитории, а страницата за software documentation обяснява как се разделят. Тази страница е за тази, която вашите клиенти реално отварят.
Шаблонът не е ръководството. Списъкът със секции се пише за двадесет минути. Това, което решава дали едно ръководство за потребителя ще работи, е структурното допускане, което повечето шаблони наследяват, без да го забелязват — и то е грешно.
Форматът следва употребата. Безплатен шаблон за ръководство за потребителя на софтуер във Word файл е подходящ за ръководство, доставяно като документ — днес това е по-скоро малцинствен случай, но все още е често при on premise софтуер и регулирани продукти. А безплатен шаблон за потребителско ръководство във Word файл е същата традиция под по-старо име. Безплатен шаблон за ръководство стъпка по стъпка във Word с оформление, което е най-близко до общото начало. Безплатен шаблон за ръководство за потребителя на софтуер във формат PPT оформление е подходящ за обучителни материали, извлечени от ръководството, а не за самото ръководство. А безплатен шаблон за ръководство за потребителя на софтуер във формат Excel файл е подходящ за инвентар на съдържанието, а не за ръководството. Повечето ръководства за потребителя вече живеят в help сайт и това променя структурата значително — поради причината по-долу.
Никой не чете ръководство за потребителя от началото
Погледнете аналитиката за който и да е онлайн help сайт и едно число приключва спора.
Делът на посещенията, които започват от началната страница или от страницата със съдържанието, е малък. Повечето потребители пристигат директно на дълбока страница — от уеб търсене или от help линк в самия продукт — с един конкретен въпрос.
Те не са прочели въведението. Не знаят в коя глава се намират. Не са видели секцията с терминологията, инструкциите за настройка или бележката в глава две, която обяснява, че всичко след това предполага конфигуриран акаунт.
И все пак почти всяко ръководство за потребителя е структурирано като книга: страница със съдържанието, глави в логичен ред и страници, които предполагат, че читателят е преминал през предходните. Тази структура е наследена от печатните ръководства, където е била правилна, и се запазва в онлайн help, където вече не е.
Резултатът е документ, който е кохерентен за автора си и „разбит“ за реалния си читател. Страница, която започва с „следва от предходната секция“, е задънена улица за седемдесетте процента хора, които не са дошли от предходната секция.
Как да персонализирате този шаблон в Trupeer
Стъпка 1: Отворете секцията Templates
Отидете в секцията Templates от основната навигация.
Стъпка 2: Изберете и отворете шаблон
Кликнете върху който и да е шаблон, с който искате да работите, за да го отворите.
Стъпка 3: Разгънете изгледа на шаблона
Ако е нужно, разгънете изгледа на шаблона, за да видите пълното оформление и детайлите ясно.
Стъпка 4: Редактирайте шаблона
Кликнете върху Edit, за да започнете да променяте избрания шаблон.
В редактора можете да:
Добавяте нови секции
Дефинирате или актуализирате правила за форматиране
Добавяте лого и настройвате позицията му и свързаните настройки
Стъпка 5: Запазете персонализирания си шаблон
След като направите всички необходими промени, кликнете върху Save, за да запазите актуализирания шаблон като свой.
Стъпка 6: Прегледайте и фино настройте шаблона
Когато искате да видите как изглежда вашият персонализиран шаблон, отворете Preview.
От екрана за преглед можете да продължите да правите корекции директно, ако е нужно, като гарантирате, че шаблонът се показва точно както искате.
С шаблон за ръководство за потребителя на софтуер можете да:
Спестите часове при писане: Пропуснете празната страница със структура, създадена за ръководства за потребителя.
Намалите тикетите за поддръжка: Ясните ръководства помагат на потребителите да се обслужват сами.
Останете в бранд: Приложете логото, шрифтовете и цветовете си с brand kit-а на Trupeer.
Подобрите приемането: Фокусирани върху задачите ръководства помагат на потребителите да получат стойност по-бързо.
Добавите видео обиколки: Вградете видео за стъпки, които е трудно да се обяснят с текст.
Достигнете до глобални потребители: Превеждайте ръководствата за потребителя на 65+ езика с един клик.
Всяка страница е страница първа
Правилото за дизайна следва директно. Пишете всяка страница така, сякаш това е единствената страница, която читателят някога ще види, защото за повечето от тях е.
Шест последствия — и всички са евтини.
Посочвайте какво приема страницата, на самата страница. Не в предговор. Ако задачата изисква администраторска роля, конфигурирана интеграция или завършена стъпка за настройка, кажете го в първите две реда — там, където човек може да открие, че е на грешното място, преди да отдели пет минути, за да разбере.
Повтаряйте, вместо да правите кръстосани препратки. Три реда с повторени предпоставки са по-евтини от линк, който читателят трябва да следва, да прочете и да се върне обратно. Повторението обижда авторите и помага на читателите, а читателят е този, за когото пишете.
Премахнете всякакви препратки към позиция. Както е описано по-горе, в предходната секция, използвайки метода от 5.2. Всяко от тези допускания предполага ред на четене, който повечето читатели не следват. Заменете го или с реалната инструкция, или с именуван линк.
Дайте заглавие на страницата като въпрос, а не като функция. Разгледано по-надолу, защото разликата е между това да бъдете открити и да не бъдете.
Завършвайте с една или две избрани следващи стъпки. Не навигационно дърво. Читателят е приключил нещо и обикновено има една очевидна следваща стъпка — назовете я.
Обединете всяка страница, която не може да стои самостоятелно. Ако една страница наистина няма смисъл без друга, те са една страница, разделена за удобството на автора.
Най-добрият безплатен шаблон за ръководство за потребителя на софтуер е следователно този, който ви позволява да пишете по този начин. Тестът отнема секунди. Отворете произволна страница в ръководството си „на студено“, сякаш сте попаднали на нея от търсене, и си задайте въпроса дали бихте могли да изпълните задачата. Повечето ръководства се провалят по-голямата част от страниците си, а провалите са концентрирани в средните глави, където авторите са имали най-много контекст в главите си.
Какво трябва да съдържа страницата с ръководство за потребителя на софтуер
Компоненти за една страница — тъй като страницата, а не книгата, е единицата.
Компонент | Какво прави |
|---|---|
Заглавие като въпрос на потребителя | Какво биха въвели или попитали, а не как се нарича функцията вътрешно. |
За какво е тази страница | Един ред. Какво ще сте постигнали в края. |
Какво приема | Роля, разрешения, предишна настройка, предишно състояние. Посочено, а не линкнато. |
Номерирани стъпки | По едно действие във всяка, в реда на изпълнение. |
Какво трябва да видите | За всяка стъпка, когато резултатът не е очевиден — за да знае читателят дали да продължи. |
Скрийншот или кратко видео, където разпознаването надделява над описанието | Само когато си заслужава мястото — по причини, разгледани по-долу. |
Чести проблеми | Два или три, взети от тикетите за поддръжка, а не измислени. |
Следващи стъпки | Една или две, избрани съзнателно. |
Последна проверена дата и версия | Кога последно някой е изпълнил тези стъпки и коя версия на продукта. |
Като цяло, освен това, ви трябват и работещо търсене, възможност читателите да сигнализират, че дадена страница е грешна, и собственик. Линкът за сигнал е най-евтиният механизъм за качество, който се предлага, и почти никой няма такъв.
Безплатен шаблон за ръководство за потребителя на софтуер: структурата, която да копирате
Запълнен с реален пример, а не с плейсхолдъри. Софтуерът е за управление на ветеринарни практики.
Копирайте оттук.
Заглавие. Как да върнете пари на клиент. Не: обработка на обръщане на кредитно известие.
За какво е тази страница. Върнете пари на клиент за фактура, която вече е платил, и я запишете коректно към счетоводните сметки на практиката.
Какво приема. Имате разрешение Billing. Практиките по Standard план имат това по подразбиране само за мениджъри на практики. Фактурата е платена и е съгласувана. Ако не е платена, търсите анулиране на фактура — това е различна страница и е линкната в края.
Стъпки.
Отворете записа на клиента и изберете таб Billing. Трябва да видите списък с фактури със статус за всяка.
Намерете платената фактура. Платените фактури показват зелен отметка. Ако показва жълт часовник, все още не е съгласувана и трябва да изчакате съгласуването, преди да върнете парите.
Изберете фактурата и след това Refund. Отваря се панел за връщане, показващ пълната сума.
Въведете сумата за връщане. Допускат се частични връщания. Сумата не може да надвишава платената обща сума.
Изберете причина от списъка. Тя се показва в извлечението на клиента, така че изберете тази, която сте готови да прочетат.
Изберете Process refund. Трябва да видите потвърждение с референция за връщане, започваща с REF.
Какво трябва да видите след това. Статусът на фактурата се променя на Refunded или Partially refunded. Връщането се появява в day book в рамките на петнадесет минути.
Чести проблеми.
Бутонът Refund е оцветен в сиво, което обикновено означава, че фактурата не е съгласувана. Изчакайте и обновете.
Връщането не се появява в day book, което обикновено означава, че е обработено след крайния час за day book и ще се появи утре.
Не виждате таб Billing изобщо, което означава, че нямате разрешение Billing. Вашият мениджър на практиката може да го предостави.
Следващи стъпки. Само две. Анулиране на неплатена фактура. Генериране на извлечение на клиент.
Последна проверка. 7 май, на версия 14.2, от член на екипа за поддръжка, следвайки тези стъпки от началото.
Копирайте оттук.
Забележете, че секцията с допускания дублира информация, която също се намира на страницата с разрешенията. Това дублиране е умишлено и е смисълът.
Пример за ръководство за потребителя: сто и дванадесет страници, които се нуждаеха от още една страница
Marlbury Systems предоставя софтуер за управление на практики на около четири и половина хиляди ветеринарни практики. Нейното ръководство за потребителя стигаше до сто и осемдесет страници, публикувано онлайн, структурирано като ръководство: getting started, clients and patients, appointments, clinical, billing, reports, administration.
То беше задълбочено, точно и добре написано. Създадено беше от технически писател, който познаваше продукта добре.
Две числа от аналитиката стартираха разследването. Седемдесет и осем процента от посещенията пристигаха директно на дълбока страница — от търсачка или от help линк в продукта. А средното време на страница беше четиринадесет секунди.
Четиринадесет секунди не е четене. Това е пристигане, сканиране и напускане.
Екипът за поддръжка предостави другата половина от картината. Петте най-посещавани help страници генерираха повече тикети от всички останали — което е обратното на това, за което служи една help страница.
Някой одитира ръководството спрямо един-единствен въпрос: може ли читател, който пристига „на студено“ на тази страница, да изпълни задачата.
Сто и дванадесет от сто и осемдесетте страници съдържаха поне една препратка, която изискваше друга страница. Както е описано по-горе. Следва от предходната секция. Използвайки метода в 5.2. След като приключите настройката в глава първа.
Страницата за връщане на пари, една от най-посещаваните в целия ръководство, започваше с изречение, което препращаше читателя към предходната секция за това как да намери фактура. Повечето хора, които я четяха, никога не бяха виждали предходната секция и нямаше причина да знаят, че съществува.
Пренаписването не промени факти. Предпоставките бяха преформулирани на всяка страница, вместо да бъдат линкнати. Препратките към позиция бяха заменени с реални инструкции. Заглавията на страниците бяха пренаписани спрямо собствения лог за търсене на сайта, който показваше, че потребителите търсят „refund“, докато страницата беше озаглавена „credit note reversal“. Всяка страница получи кратък блок с допускания и две избрани следващи стъпки.
Четири месеца по-късно времето на страница се беше променило от четиринадесет секунди на седемдесет и една. Тикетите, които препращаха към топ двадесет теми, бяха спаднали с около четиридесет и един процента. Делът на потребителите, които отваряха help в продукта и след това не се свързваха с поддръжката, се беше променил от тридесет и четири процента на петдесет и осем.
Ръководството стана по-дълго, защото повтарящите се предпоставки заемат място. И също така започна да се използва.
Как да напишете ръководство за потребителя на софтуер в шест стъпки
Вземете списъка със страници от данните за поддръжка и търсене, а не от структурата на менюто на продукта. Тикетите ви казват какво хората не могат да направят, а логът за търсене ви казва кои думи използват.
Напишете по една страница за всяка задача, озаглавена като въпрос. Ако заглавието съдържа име на функция, което вашите потребители не биха казали на глас, променете го.
Напишете първо блока с допускания, преди стъпките. Това е секцията, която спира някой да губи пет минути на грешната страница.
Напишете стъпките, като ги изпълнявате, а не по памет. Всичко, което правите автоматично, иначе ще липсва.
Вземете чести проблеми от опашката с тикети. Три реални случая са по-добри от десет измислени.
Тествайте, като пристигнете „на студено“. Отворете страницата така, както би го направил непознат, и се опитайте да изпълните задачата, без да отваряте нищо друго.
Стъпка първа е това, което разделя ръководство, организирано около потребителите, от такова, организирано около софтуера. Структурата на менюто на продукта е карта на това как е изграден софтуерът. Тя не е карта на това какво се опитват да правят хората.
Как да назовавате страниците, за да ги намират хората
Заглавията имат по-голямо значение в ръководството за потребителя, отколкото в почти който и да е друг документ, защото търсенето е основната входна точка и заглавието носи най-голямата част от съвпаденията.
Три правила.
Използвайте думата на потребителя, а не вашата. Ако логът ви за търсене показва, че хората пишат „refund“, а страницата ви казва „credit note reversal“, страницата е невидима за тях. Проверете лога. Това е най-евтиното проучване и повечето екипи никога не го отварят.
Започнете с глагола. Как да върнете пари на клиент. Не: връщания на клиент, overview of. Първо глаголът съответства на начина, по който хората питат, и се чете по-бързо в списък с резултати.
По една задача на заглавие. Страница със заглавие „управление на фактуриране“ покрива всичко и не съвпада с нищо. Разделете я.
Когато вътрешният термин наистина е правилният, защото се появява в интерфейса, поставете думата на потребителя в първия ред на страницата, за да остане откриваема. Оптимизирате за две аудитории едновременно: търсачката и човека, който сканира резултатите.
Скрийншоти и проблемът с поддръжката
Скрийншотите помагат най-много там, където разпознаването надделява над описанието: идентифициране на един контрол сред много, показване на непознат екран, потвърждаване как изглежда успешният резултат.
Те са и най-голямата единична отговорност за поддръжка в ръководството за потребителя. Ръководство с двеста скрийншота е ръководство с двеста неща, които се чупят безшумно при следващата промяна на интерфейса, а интерфейсите се променят на всеки няколко седмици.
Три правила държат разходите пропорционални.
Използвайте ги там, където назоваването е трудно, и ги пропускайте там, където инструкцията е ясна сама по себе си. Скрийншот на бутон с надпис Save не добавя нищо.
Анотирайте директно, вместо да описвате къде да се гледа в текста. Ненаправен (без маркировка) скрийншот на натоварен екран е пъзел.
Датирайте ги и знайте коя версия на продукта показват, за да може читателят да прецени дали това, което гледа, все още съществува.
Честната позиция е, че повечето екипи започват с добри намерения относно визуалната документация и завършват с текст, защото разходът за „връщане“ след всяко пускане надвишава наличното време. Това е проблем на производството, а не на готовността, и е разгледан по-надолу.
Ръководство за потребителя, потребителско ръководство или how-to guide?
Три припокриващи се термина и разграниченията са полезни при избора на структура.
A user guide обхваща софтуерен продукт през задачите, които изпълняват неговите потребители. Множество страници, отваряни по всяко време, поддържани непрекъснато.
A user manual е същото нещо в по-старата, оформена като документ традиция, и терминът все още е стандартен за физически продукти и за софтуер, доставян on premise. Когато manual придружава физическо оборудване, съдържанието за безопасност и разположението на предупрежденията носят задължения, които софтуерните ръководства не имат, и instruction manual традицията покрива тази област.
A how to guide е една задача, самостоятелна, и по същество е една страница от user guide, публикувана самостоятелно.
Практическото следствие е, че ако пишете всяка страница да стои самостоятелно, както е аргументирано по-горе, вашето user guide вече е колекция от how-to guides с навигация отгоре — това е правилната архитектура за онлайн help.
A quick reference guide е различно отново: лист за справка за човек, който вече е обучен, покрит на quick reference guide страницата.
Какво не може да поправи безплатният шаблон за ръководство за потребителя на софтуер
Ръководство, структурирано около продукта. Нито един шаблон не превръща ръководство, организирано около функция, в такова, организирано около задачи. За това са нужни данните за поддръжка и търсене.
Страници, които никой не може да намери. Добре написана страница с грешно заглавие е невидима. Заглавията са най-евтиното нещо за поправяне и най-рядко се преразглеждат.
Скрийншоти, които никой не поддържа. Нито безплатно изтегляне на шаблон за ръководство за потребителя на софтуер, нито безплатно изтегляне на шаблон за потребителско ръководство ще „върне“ двеста изображения след redesign.
Продукт, който изисква толкова много насоки. Ако една задача наистина изисква четиринадесет стъпки и три предупреждения, документацията върши работа, която интерфейсът трябва да върши. Напишете го така или иначе и предайте наблюдението на този, който отговаря за продукта.
Показвайте задачата, вместо да я описвате
Ръководството за потребителя е типът документ с най-високи изисквания за изображения и най-висока цена за поддръжка на изображения, и тези две факта заедно са причината толкова много ръководства да са по-зле от това, което авторите им са възнамерявали.
Математиката е безмилостна. Ръководство от сто страници с по три изображения на страница са триста заснемания, изрязвания, анотации и поставяния. След redesign — пак триста. Никой няма това време в седмица на пускане, затова изображенията остаряват, а остарелите изображения са по-лоши от липсата им, защото читателите им вярват.
Trupeer AI променя базата на разходите. Някой изпълнява задачата веднъж, докато записва, и резултатът е написана страница стъпка по стъпка със заснети, анотирани и поставени скрийншоти, заедно с кратко видео, в собствения ви бранд. Страница, която отнема следобед, отнема минути, а повторното заснемане след redesign означава презапис, а не повторно снимане.
Запишете го. Брандирайте го. Преведете го. Trupeer-нете го.
Два допълнителни момента са важни конкретно за ръководствата за потребителя. Видеото стои на страницата до написаните стъпки — това обслужва както читателя, който иска да сканира, така и читателя, който иска да гледа, и това са реално различни хора, а не един и същ човек в различни моменти. И когато вашите потребители са на няколко езика, същият запис генерира една и съща страница за всеки, така че ръководство, преведено веднъж, не се разминава с продукта, докато английската версия е в крак.
Материалът се намира във вашата knowledge base и служи и като training за служителите по поддръжка, които често са най-тежките потребители на ръководство за потребителя. Последователността във вашите документи е въпрос на настройване на brand kit веднъж, а настройката е покрита в document template setup guide.
Често задавани въпроси
Има ли безплатен шаблон за ръководство за потребителя на софтуер във Word версия?
Word е подходящ за ръководство, доставяно като документ — това важи за on premise софтуер, регулирани продукти, при които се изисква ръководство с версия, и за всичко, което се предава договорно. Безплатен шаблон за ръководство за потребителя на софтуер във Word файл работи добре за тези случаи.
За софтуер с help сайт обаче работи зле. Потребителите пристигат чрез търсене, нуждаят се всяка страница да е адресируема, а Word документът създава един дълъг файл без входна точка за всяка страница. Ако публикувате онлайн, използвайте система за документация и оставете Word за доставката с версии.
Има ли безплатна версия на шаблон за ръководство за потребителя стъпка по стъпка във Word?
Да, и структурата по-горе се поставя директно. Изградете безплатното оформление на шаблона за ръководство за потребителя стъпка по стъпка във Word с една задача на секция, номерирани стъпки с по едно действие във всяка и ред с допускания в горната част на всяка секция.
Дръжте секциите достатъчно кратки, за да стоят самостоятелно. Най-честият проблем в ръководство на база Word е секция, която има смисъл само след предходната — тя е невидима в документ и фатална, когато същото съдържание се публикува онлайн.
Има ли безплатна версия на шаблон за ръководство за потребителя на софтуер във формат PPT?
Слайдовете са подходящи за обучение, извлечено от ръководство, а не за самото ръководство. Безплатен шаблон за ръководство за потребителя на софтуер във формат PPT deck е разумен формат за сесия за walkthrough или onboarding уебинар.
Не го използвайте като референция. Слайдовете не се търсят по начина, от който потребителите се нуждаят, не могат да се линкват от вътре в продукта и ако се чете само deck-ът, липсва разказът, който носи по-голямата част от смисъла му.
Има ли безплатна версия на шаблон за ръководство за потребителя на софтуер във формат Excel?
Excel не е формат за ръководство и наистина е полезен заедно с такова. Безплатен шаблон за ръководство за потребителя на софтуер във формат Excel файл работи добре като инвентар на съдържанието: по един ред на страница, със заглавието ѝ, собственик, последна проверена дата, версия на продукта, месечни посещения и свързан обем на тикетите.
Този инвентар ви казва кои страници да поправите първо. Страниците с висок трафик и висок свързан обем тикети са тези, които се провалят, и без инвентара ще поправяте която и да е страница, за която някой се е оплакал най-скоро.
Има ли безплатно изтегляне на шаблон за ръководство за потребителя на софтуер, което си струва да се използва?
Структурата на страницата отнема двадесет минути за изграждане, така че безплатно изтегляне на шаблон за ръководство за потребителя на софтуер спестява малко, а повечето публикувани шаблони са оформени като книги със страница със съдържанието и номерирани глави.
Приемането на тази форма е грешката, срещу която твърди тази страница. Ако използвате такава, премахнете номерацията на главите и направете всяка страница самостоятелна — това е промяна в начина, по който пишете, а не в самия файл.
Идентично ли е това с Word файл за шаблон на потребителско ръководство?
Като цяло — да, с разлика в традицията, а не в съдържанието. Word файлът за шаблон на потребителско ръководство идва от линията на печатното ръководство, така че предполага последователно четене, страница със съдържанието и номера на страниците.
Това работи за документ, който наистина ще бъде четен като документ — включително регулирани доставки и ръководства, които придружават физическо оборудване. За онлайн help на софтуер допусканията зад това са източникът на проблема, описан на тази страница.
Откъде мога да получа безплатно изтегляне на шаблон за потребителско ръководство?
Широко достъпно и до голяма степен взаимозаменяемо, защото номериран списък със задачи не е трудна структура. Безплатното изтегляне на шаблон за потребителско ръководство ще ви даде страница със съдържанието, заглавия на глави и структура на страниците.
Двете промени, които си струва да направите във всеки от тях, са блок с допускания в горната част на всяка секция и премахване на всякакви препратки към позиция. Тези две редакции отнемат час върху съществуващо ръководство и струват повече от промяната на шаблона.
Кой е най-добрият безплатен шаблон за ръководство за потребителя на софтуер?
Най-добрият безплатен шаблон за ръководство за потребителя на софтуер е този, който третира страницата, а не книгата, като единица — и почти никой не го прави.
Ако сравнявате опции, проверете едно нещо: има ли шаблонът място на всяка страница, където да запишете какво се приема, че читателят вече е направил? Това единствено поле е това, което кара една страница да преживее пристигането ѝ от търсене — така ще стигне до нея огромното мнозинство от вашите читатели.
