Стъпка по стъпка ръководство за създаване и управление на документация за продукти | Управление на продукти #31

Какво е документация на продукта?

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

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

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

Елементи на документацията на продукта

Документацията на продукта може да включва:

• Ръководство за потребителя – документ, който предоставя информация за функциите на продукта, инсталация, настройки и отстраняване на проблеми.
• Ръководство за потребителя – документ, който обяснява как да се извършват различни задачи с продукта, като например как да се използва програма за редактиране на снимки или как да се играе компютърна игра.
• База знания – колекция от статии или уеб страници, които отговарят на често задавани въпроси или предоставят допълнителна информация за продукта. Пример за това е разделът “Център за помощ” или “Поддръжка” на уебсайта. Често се използва и като източник на информация за чатбот, който помага на клиентите.
• Често задавани въпроси (FAQ) – списък с често задавани въпроси и отговори за продукта. Например, уебсайт или PDF файл, който включва отговори на въпроси като: “Как да нулирам паролата си?”, “Как да се свържа с клиентската поддръжка?” или “Какви са системните изисквания за продукта?”.
• Уроци – видеа, обикновено публикувани на уебсайта на компанията или YouTube, които демонстрират как да се използва продуктът или как да се извършват определени задачи.
• Диаграми и инфографики – графични представяния на структурата, функцията или процеса на продукта. Например, диаграма, показваща какви опции да изберете при конфигуриране на API.

Как да създадете документация на продукта?

Разбиране на целевата аудитория

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

• Кой ще използва този документ? – Ще бъде ли това нов потребител или по-напреднал потребител?
• В кой момент потребителят ще посегне към този документ? Търсят ли обща или допълнителна информация за възможностите на инструмента, или решение на конкретен проблем?
• На какво устройство ще го използват? Ако е мобилно устройство, достатъчно ли са ясни видеата?
• Какви са техните нужди и очаквания? Ще предпочете ли потребителят да гледа динамично видео или да разгледа диаграма?

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

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

Ясна комуникация

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

• Използвайте прост език – избягвайте технически език и сложни термини. Например, вместо да кажете “инициирайте проект”, можете да кажете “започнете проект”.
• Бъдете конкретни – предоставяйте примери, за да помогнете на потребителите да разберат как да използват продукта. Например, вместо да кажете “позволява ви да добавите членове на екипа в проект”, кажете “добавете член на екипа в проект, като кликнете на зеления бутон в долната част на страницата за управление на проекти” и добавете екранна снимка с визуален намек.
• Избягвайте пасивния глас – активният глас е по-лесен за разбиране и четене. Например, вместо да кажете “проектът може да бъде стартиран от мениджъра”, кажете “мениджърът може да стартира проекта”.

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

Използване на визуални материали в документацията на продукта

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

Актуализиране и поддържане на документацията на продукта

Документацията на продукта не е статичен документ. Тя трябва да бъде актуализирана редовно, за да отразява промените в продукта. Редовните актуализации са от съществено значение, за да служи документацията на целта си. Например, ако въвеждате нова функция в софтуера за управление на продукти, трябва да актуализирате документацията на продукта, за да я отразите.

Публикуване и разпространение на документацията на продукта

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

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

Мениджърите на продукти разполагат с много инструменти, които могат да им помогнат да създават и управляват документацията на продукта. Популярни решения включват:

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

• Firmbee е цялостен инструмент за управление на проекти и екипи, който позволява на потребителите да изпълняват задачи от всяка точка на света в реално време. Мениджърите на продукти могат лесно да организират своята работа и работата на колегите си, да проследяват напредъка, да контролират бюджетите и да провеждат процеси на набиране на персонал.

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

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

Резюме

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

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

Ако харесвате нашето съдържание, присъединете се към нашата общност на активните пчели в Facebook, Twitter, LinkedIn, Instagram, YouTube, Pinterest, TikTok.