Статии „как да“ са един от най-натоварените с трафик формати на съдържание в уеб. С Trupeer можете да спестите часове при създаването на статии „как да“ — като започнете с безплатен шаблон за статия „как да“, персонализирате го с вашите brand guidelines и превърнете всяка статия в ангажиращ видеоурок, който дава на читателите втори начин да научат.

Статията „как да“ поставя читателя в много конкретно състояние. Те са по средата на нещо, не работи, и вече са отделили повече време, отколкото са искали. Те не четат — сканират за частта, която ще ги освободи.

Почти всички правила за писане на такива статии произтичат от това.

Изтеглете шаблона за статия „как да“

Безплатно, за редакция, без воден знак.

Трите начина, по които статия „как да“ се проваля

Всяка повреда е една от тези и изисква различно решение.

Повечето съвети за писане адресират третото преминаване. Повечето статии се провалят при първите две.

Преминаване едно: заглавието

Ако заглавието не съвпада с думите, които читателят би използвал, статията не съществува за него.

Пишете задачата, а не функцията. „Как да експортирате отчета си като CSV“ е по-добре от „Използване на модула за експортиране“. Хората търсят това, което се опитват да направят.

Използвайте техния речник. Вътрешното ви име за функция не е това, което използват клиентите. Вземете формулировките от тикетите за поддръжка и от търсенето в сайта.

Започнете с глагола. „Как да нулирате паролата си“ се сканира по-бързо от „Нулиране на паролата: ръководство“.

Бъдете достатъчно конкретни, за да бъдете изключващи. „Как да добавите потребител“ е двусмислено, ако имате три вида потребители. „Как да добавите администраторски потребител към работно пространство“ — не е.

По една задача на заглавие. Ако заглавието съдържа „и“, имате две статии.

Преминаване две: началото

Читателят е кацнал на страницата. Има около пет секунди, за да реши дали това е правилната страница.

Началният блок отговаря на три въпроса, преди да започнат стъпките.

Какво прави тази статия. Едно изречение. „Тази статия ви показва как да свържете счетоводната си система, за да се синхронизират фактурите автоматично.“

За кого е. Всяка роля, изискване за разрешения или план. „Нужен ви е администраторски достъп, за да направите това.“

От какво се нуждаете първо. Предпоставки, посочени преди стъпка първа, а не открити в стъпка четвърта.

Това последно предотвратява най-честото разочарование в техническата документация — да стигнете до три стъпки и да се окаже, че ви трябва нещо, което нямате. Предпоставките трябва да са най-отгоре, винаги.

Добавете очаквано време, когато е повече от няколко минути. „Това отнема около 15 минути“ позволява на някого да реши дали да започне сега или да се върне по-късно.

Преминаване три: стъпките

Тук читателят или приключва, или се отказва.

• По едно действие на стъпка. Ако стъпка съдържа „и след това“, разделете я.

• Започвайте всяка стъпка с глагола. „Кликнете върху Настройки“ вместо „След това трябва да кликнете върху Настройки“.

• Кажете къде е преди какво. „В горния десен ъгъл кликнете върху Export“ им казва къде да погледнат първо.

• Назовете какво ще видят. Точни етикети на бутони, с точната главна буква. Ако бутонът казва „Save & close“, напишете го така.

• Номерирайте ги. Булетите подсказват, че редът няма значение.

• Дръжте ги под десет стъпки, когато е възможно. По-дългите задачи се разделят на фази със подзаглавия.

• Покажете резултата. След последната стъпка кажете какво трябва да е вярно сега. „Синхронизацията се изпълнява на всеки час. Ще видите последното време за синхронизация на страницата с интеграциите.“

• Не обяснявайте защо по средата на задачата. Читателят изпълнява, не учи. Поставете разсъжденията в бележка или в отделна статия за концепция.

Как да персонализирате този шаблон в Trupeer

Стъпка 1: Отворете секцията Templates

Отидете до секцията Templates от основната навигация.

Стъпка 2: Изберете и отворете шаблон

Кликнете върху който и да е шаблон, с който искате да работите, за да го отворите.

Стъпка 3: Разгънете изгледа на шаблона

Ако е необходимо, разгънете изгледа на шаблона, за да видите пълното оформление и детайлите ясно.

Стъпка 4: Редактирайте шаблона

Кликнете върху Edit, за да започнете да променяте избрания шаблон.

В редактора можете да:

• Добавяте нови секции

• Дефинирате или актуализирате правила за форматиране

• Добавяте логото и настройвате позицията му и свързаните настройки

Стъпка 5: Запазете персонализирания си шаблон

След като направите всички необходими промени, кликнете върху Save, за да запазите актуализирания шаблон като свой.

Стъпка 6: Прегледайте и фино настройте шаблона

Когато искате да видите как изглежда вашият персонализиран шаблон, отворете Preview.

От екрана за преглед можете да продължите да правите корекции директно, ако е необходимо, като гарантирате, че шаблонът се показва точно както искате.

С шаблон за статия „как да“ можете да:

• Спестите часове при писане: Пропуснете празната страница със структура, създадена за съдържание „как да“.

• Позиционирате се в търсенето: Добре структурирани статии „как да“ с HowTo schema се класират добре в Google.

• Останете в бранда: Приложете логото, шрифтовете и цветовете си с brand kit-а на Trupeer.

• Намалите натоварването на поддръжката: Ясните статии „как да“ помагат на потребителите да се обслужват самостоятелно.

• Добавите видео walkthrough-и: Вградете видеоуроци за стъпки, които трудно се обясняват само с текст.

• Достигнете до глобални читатели: Превеждайте статии „как да“ на 65+ езика с един клик.

Шаблонът за статия „как да“

Десет секции, от които четири са кратки. Основната част са стъпките и отстраняването на проблеми.

Скрийншоти

Разликата между използваема статия „как да“ и стена от инструкции.

• По един скрийншот за всяка стъпка, когато интерфейсът не е очевиден. Не за всяка стъпка, иначе статията става трудно за сканиране.

• Изрязвайте до релевантната зона. Заснемане на целия екран кара читателя да търси това, което сте имали предвид.

• Анотирайте леко. Един правоъгълник или стрелка. Множество анотации се конкурират помежду си.

• Показвайте състояние, не само локация. Когато стъпка променя нещо, „преди и след“ струва повече от единично изображение.

• Избягвайте лични данни или данни на клиенти. Използвайте демо акаунт и проверете разделите на браузъра и известията в ъгъла на заснемането.

• Отбелязвайте разхода за поддръжка. Скрийншотите остаряват при всяка промяна на интерфейса, а остарелите скрийншоти подкопават доверието в цялата статия. Това е най-силният аргумент да записвате, вместо да заснемате.

Отстраняване на проблеми

Секцията, която разделя компетентната статия от наистина полезната, и тази, която най-често се пропуска.

Избройте трите или четири неща, които реално се объркват, с думите на читателя, и решението.

След стъпка 4 нищо не се появява. Обикновено означава, че връзката не е приключила с оторизацията. Изчакайте минута и обновете. Ако пак е празно, акаунтът може да няма нужните разрешения.

Бутонът е оцветен в сиво. За това ви трябва администраторски достъп. Попитайте човека, който е настроил работното ви пространство.

Работи, но данните изглеждат грешно. Проверете филтъра за диапазон от дати, който по подразбиране е текущият месец.

Вземайте тези примери от тикети за поддръжка, а не от въображение. Ако четирима души са се свързали с вас със същия проблем след като са следвали статията, този проблем трябва да е в статията.

Слабо и по-добре

Слабо: Потребителите могат да конфигурират настройките за експортиране чрез модула за отчети, за да получат данни в различни формати според нуждите.

По-добре: За да експортирате отчет като CSV: 1. Отворете отчета. 2. В горния десен ъгъл кликнете върху Export. 3. Изберете CSV и кликнете върху Download. Файлът се появява в папката ви за изтегляния и включва всяка колона, която в момента се вижда в отчета.

Слабо: Стъпка 3: Конфигурирайте настройките за интеграцията подходящо и запазете промените си.

По-добре: 3. Въведете API ключа от вашата счетоводна система. 4. Задайте Sync frequency на Hourly. 5. Кликнете върху Save & test. Трябва да видите зеления етикет Connected.

Първата версия е една стъпка, която прави три неща, без начин да се разбере дали е сработило. Втората е три стъпки с проверим резултат.

Слабо заглавие: Integration Configuration Guide

По-добро заглавие: Как да свържете счетоводната си система

Слабо начало: Тази статия предоставя обзор на функционалността за експортиране, налична в платформата.

По-добро начало: Тук ще ви покажем как да експортирате отчет като CSV, Excel или PDF. Нужен ви е достъп за преглед на отчета. Отнема около минута.

Видове статии за документация

„Как да“ е един от четири типа, а смесването им е най-честата структурна грешка в документацията.

Грешката е да обяснявате концепции вътре в статия „как да“. Читателят изпълнява и не иска фона. Вместо това свържете към статията за концепция и дръжте стъпките чисти.

Обратната грешка е статия за концепция с три стъпки, заровени в средата, които никой няма да намери, когато са му нужни.

Дължина на статията

По-кратка, отколкото подсказва инстинктът. Статия „как да“ трябва да покрива една задача и да спира.

Ако стигне над десет стъпки, потърсете естествено разделяне. „Как да настроите X“ често всъщност е „Как да създадете X“, „Как да конфигурирате X“ и „Как да поканите хора в X“ — това са три статии, които могат да се намират независимо и да се свързват в последователност.

Дългите статии се провалят и при преминаване едно, защото една статия, която покрива шест задачи, може да има само едно заглавие — което означава, че пет от тези задачи не могат да бъдат намерени.

Формати

Word за изготвяне и преглед, защото проследяваните промени и коментарите правят цикъла на преглед управляем. Там трябва да се пишат повечето статии, преди да се доближат до система за публикуване.

PDF за всичко, което се печата, раздава на обучение или е нужно офлайн. Това е и правилният формат за ръководство, насочено към клиенти, което прикачвате към имейл.

PowerPoint, когато „как да“ се превръща в обучение. По една стъпка на слайд, по един скрийншот на всеки — работи добре за сесия walkthrough. По-малко е подходящо като справочен материал след това, така че повечето екипи се нуждаят и от версията в Word.

Вашият център за помощ или база знания за всичко, насочено към клиенти, което трябва да се намира и търси — а това са повечето от тях. Word и PDF са формати за изготвяне и разпространение, а не за публикуване.

Поддържане на статиите

Документацията се влошава тихо, а остарялата документация е по-зле от липсата, защото хората я следват и тя се проваля.

Назначете собственик за всяка статия. Запишете версията на продукта, спрямо която е написана. Преглеждайте след всяко пускане, което засяга функцията, а иначе — по фиксиран цикъл.

Най-надеждният сигнал за поддръжка е тикет за поддръжка за нещо, което статията покрива. Това означава или че статията е грешна, или че е вярна, но не може да се намери. И двете си струва да се поправят, а и двете са невидими, докато някой не следи за тях.

Скрийншотите са елементът с най-висока поддръжка — и това си струва да се отчете при това колко много използвате и как ги създавате.

Как да измерите дали работи

• Прегледи, които ви показват дали може да се намира.

• Тикети за поддръжка по същата тема след публикуването. Трябва да намалеят. Ако не намаляват, статията не работи или не може да се намери.

• Търсени термини без резултати, които показват кои статии липсват.

• Време на страницата, интерпретирано внимателно. Дълго време може да означава задълбочено четене или объркване.

• Обратна връзка за статията, ако центърът ви за помощ я предлага, макар че обикновено процентът на отговор е нисък.

• Отклоняване, тоест хората, които са видели статията и след това не са се свързали с поддръжката.

Най-полезното единично число е обемът на поддръжката по темата преди и след публикуването. Всичко останало е заместител.

Как да напишете статия „как да“

1. Разберете какво хората реално питат, от тикети за поддръжка и търсене в сайта. Не гадайте темата.

2. Напишете първо заглавието, като задача с думите на читателя. Ако не можете, обхватът е неясен.

3. Изпълнете задачата сами, докато пишете, или гледайте някой да я изпълнява. Статиите, написани по памет, пропускат стъпки.

4. Избройте предпоставките, докато ги срещате.

5. Пишете по едно действие на стъпка, първо глагол, с точните етикети на интерфейса.

6. Заснемайте или записвайте, докато вървите, а не после по памет.

7. Посочете очаквания резултат.

8. Добавете отстраняване на проблеми от реални тикети.

9. Нека някой, който не е запознат, го следва без помощ. Всяка въпрос, който задава, е дефект.

10. Публикувайте и после наблюдавайте обема на поддръжката по тази тема.

Девета стъпка е единственият истински тест. Статия, прегледана от човек, който вече знае задачата, винаги ще изглежда добре.

Добри практики

• Заглавия, базирани на задачи, с речника на читателя.

• Предпоставките преди стъпка първа, винаги.

• По едно действие на стъпка, първо глагол.

• Точни етикети на интерфейса, точна главна буква.

• Скрийншотите са изрязани и леко анотирани.

• Очакваният резултат е посочен след последната стъпка.

• Отстраняване на проблеми, базирано на реални тикети.

• По една задача на статия, под десет стъпки.

• Концепциите са свързани, а не вградени.

• Тествана от човек, който не е изпълнявал задачата.

Чести грешки

• Заглавия, кръстени на функции, а не на задачи.

• Предпоставките са открити в стъпка четвърта.

• Стъпки, които съдържат по три действия.

• Неясни инструкции като „конфигурирайте настройките подходящо“.

• Етикетите на интерфейса са преразказани, а не цитирани.

• Скрийншоти на целия екран без изрязване.

• Данни на клиенти, видими в скрийншот.

• Няма очакван резултат, така че читателят не може да разбере дали е сработило.

• Няма секция за отстраняване на проблеми.

• Концепциите са обяснени вътре в стъпките.

• Шест задачи в една статия, пет от тях не могат да бъдат намерени.

• Написано по памет, вместо като изпълните задачата.

• Прегледано само от хора, които вече знаят как.

• Скрийншотите никога не се актуализират след промяна на интерфейса.

Запишете задачата вместо да я пишете по памет

Отворете шаблона в Trupeer AI, приложете вашия brand kit, за да съответстват статиите на вашата документация, и редактирайте всяка секция директно. Настройката е в template guide.

Две неща правят статиите „как да“ скъпи. Писането по памет пропуска стъпките, които изпълнявате автоматично — точно там читателите се затъват. А скрийншотите се правят бавно и остаряват при всяка промяна на интерфейса, поради което толкова много статии показват версия на продукта, която вече не съществува.

Записването решава и двете. Изпълнете задачата веднъж и Trupeer AI ще генерира написаната статия със стъпките в реда, в който реално са се случили, и със скрийншоти, заснети автоматично, плюс разказан video walkthrough от същото преминаване. Когато интерфейсът се промени, записвайте отново, вместо да правите нови скрийншоти.

Преведете я на 65+ езика и запазете набора в knowledge base, където читателите ще я намират.

Запишете я. Брандирайте я. Преведете я. Trupeer я.

Често задавани въпроси

Има ли безплатен шаблон за статия „как да“ в Word?

Да. Word е основният формат и правилното място за изготвяне, тъй като прегледът с проследявани промени е по-лесен там, отколкото в система за публикуване. Той включва пълната структура с подсказки във всяка секция. Безплатно изтегляне, без регистрация, без воден знак.

Има ли шаблон за статия в Word, безплатен за изтегляне?

Да, и работи за всяка инструктивна статия, не само за стъпка-по-стъпка. Структурата се запазва за статии за концепция, справка и отстраняване на проблеми с минимални корекции.

Има ли безплатен шаблон за статия „как да“ в PDF?

Да, като формат за печатно ръководство, подходящ за раздавани материали за обучение, onboarding пакети и всичко, което клиентът може да има нужда офлайн.

Има ли шаблон за статия в PDF?

Да, както празна версия, така и завършен пример, за да видите готова статия „как да“, преди да напишете своята.

Има ли безплатен шаблон за статия „как да“ в PPT или PowerPoint?

Да. Версията в PowerPoint превръща статия „как да“ в обучителен walkthrough — по една стъпка на слайд, с място за скрийншот на всеки. Работи добре за live сесия и по-малко добре като справочен материал след това, така че повечето екипи се нуждаят и от версията в Word.

Мога ли да изтегля безплатен шаблон за статия „как да“?

Да, всеки формат е безплатно изтегляне без нужда от акаунт и без атрибуция.

Кой е най-добрият безплатен шаблон за статия „как да“?

Този, който включва предпоставки и отстраняване на проблеми. Повечето шаблони ви дават заглавие и номерирани стъпки — лесната част. Читателите се отказват, защото откриват липсваща предпоставка в стъпка четвърта или срещат проблем, който статията не споменава, а тези две секции са това, което го предотвратява.

Какво е статия „как да“?

Кратка инструктивна статия, която покрива една конкретна задача, написана за човек, който се опитва да я направи в момента. Тя се различава от урока, който учи от нулата, и от статията за концепция, която обяснява как работи нещо.

Какво трябва да включва статия „как да“?

Заглавие, базирано на задача, едно изречение обобщение, за кого е (включително всички нужни разрешения), предпоставки преди стъпка първа, необходимо време, номерирани стъпки с по едно действие, очаквания резултат, отстраняване на проблеми за трите или четири често срещани проблема, свързани статии и метаданни, показващи собственика и датата на последния преглед.

Как се пише добра статия „как да“?

Напишете заглавието като задача с думите на читателя, изпълнете задачата сами, докато пишете, вместо да работите по памет, изброете предпоставките, докато ги срещате, използвайте по едно действие на стъпка с точните етикети на интерфейса, посочете какво трябва да е вярно в края и добавете отстраняване на проблеми от реални тикети за поддръжка. После нека някой, който не е запознат, я следва без помощ.

Колко дълга трябва да е статия „как да“?

Една задача, идеално под десет стъпки. Ако е по-дълга, обикновено става дума за няколко задачи, които биха били по-лесно намирани като отделни статии, свързани в последователност. Дългите статии се провалят и защото могат да имат само едно заглавие, което прави другите задачи вътре в тях невидими за търсене.

Каква е разликата между статия „как да“ и урок?

Статия „как да“ е за човек, който вече знае какво иска и се нуждае от конкретните стъпки. Урокът учи начинаещ, обикновено с работещ пример и повече обяснения. Разликата е в състоянието на читателя: читателят на „как да“ е нетърпелив и по средата на задачата, докато читателят на урока е отделил време, за да учи.

Трябва ли статиите „как да“ да включват скрийншоти?

За всичко, където интерфейсът не е очевиден — да, изрязани до релевантната зона и с лека анотация. Не за всяка стъпка, иначе статията спира да се сканира. Имайте предвид, че скрийншотите са елементът с най-висока поддръжка в документацията и остаряват при всяка промяна на интерфейса — това си струва да се прецени, преди да добавите дванадесет от тях.

Колко често трябва да се преглеждат статиите „как да“?

След всяко пускане, което засяга функцията, и иначе — по фиксиран цикъл, обикновено на всеки шест до дванадесет месеца. Най-полезният тригер е тикет за поддръжка за нещо, което статията вече покрива — което означава, че е или грешна, или не може да се намери.

Мога ли да персонализирам този шаблон за статия „как да“?

Да, всяка версия е напълно редактируема. Настройте секциите според стандартите ви за документация, но предпоставките и отстраняването на проблеми са двете, които си струва да запазите независимо, тъй като адресират двата момента, в които читателите най-често се отказват от статия.

Свързани шаблони

• Шаблон за техническа документация

• Шаблон за база знания

• Шаблони за статии в база знания

• Шаблон SOP

• Шаблони за инструкции за работа

• Шаблон Job aid

• Шаблон за потребителско ръководство

• Шаблон за софтуерна документация

• Шаблон за страница с ЧЗВ