Žingsnis po žingsnio vadovas, kaip kurti ir valdyti produkto dokumentaciją | Produkto valdymas #31

Kas yra produkto dokumentacija?

Produkto dokumentacija yra tekstų, vizualizacijų ir vaizdo įrašų rinkinys, aprašantis produktą, jo funkcijas, kaip jį naudoti ir kitus svarbius aspektus. Pagrindinis dokumentacijos kūrimo tikslas yra padėti vartotojams suprasti, kaip naudoti produktą, ypač jo pažangias funkcijas.

Dokumentacija yra svarbi, ypač jei kuriate skaitmeninį produktą, kuris ne tik tarnaus galutiniams vartotojams, bet ir integruosis su kitais produktais – pavyzdžiui, leis eksportuoti duomenis į kitą programą arba naudoti lokalizacijos ar kontaktų duomenų bazę.

Pavyzdžiui, projekto valdymo įrankio dokumentacija gali apimti informaciją apie tai, kaip sukurti naują projektą, kaip pridėti komandos narius prie projekto ir suteikti jiems leidimą keisti tik tam tikras užduotis, kaip priskirti užduotis keliems žmonėms vienu metu ir kaip stebėti jų pažangą.

Produkto dokumentacijos elementai

Produkto dokumentacija gali apimti:

• Vartotojo vadovas – dokumentas, teikiantis informaciją apie produkto funkcijas, diegimą, nustatymus ir trikčių šalinimą.
• Vartotojo gidas – dokumentas, paaiškinantis, kaip atlikti įvairias užduotis su produktu, pavyzdžiui, kaip naudoti nuotraukų redagavimo programą arba kaip žaisti kompiuterinį žaidimą.
• Žinių bazė – straipsnių ar tinklalapių rinkinys, atsakantis į dažniausiai užduodamus klausimus arba teikiantis papildomą informaciją apie produktą. Pavyzdys būtų “Pagalbos centras” arba “Pagalba” skyrius svetainėje. Taip pat dažnai naudojama kaip informacijos šaltinis chatbot’ui, kuris padeda klientams.
• DUK – dažniausiai užduodamų klausimų ir atsakymų sąrašas apie produktą. Pavyzdžiui, svetainė arba PDF failas, kuriame pateikiami atsakymai į klausimus, tokius kaip: “Kaip atnaujinti slaptažodį?”, “Kaip susisiekti su klientų aptarnavimu?” arba “Kokie yra produkto sistemos reikalavimai?”.
• Pamokos – vaizdo įrašai, paprastai skelbiami įmonės svetainėje arba „YouTube“, kurie demonstruoja, kaip naudoti produktą arba atlikti tam tikras užduotis.
• Diagramas ir infografikas – grafiniai produkto struktūros, funkcijos ar proceso vaizdai. Pavyzdžiui, diagrama, rodanti, kokias parinktis pasirinkti konfigūruojant API.

Kaip sukurti produkto dokumentaciją?

Suprasti tikslinę auditoriją

Pirmas žingsnis kuriant produkto dokumentaciją yra suprasti auditoriją, kuriai šis konkretus dokumentas bus skirtas. Atsakykite į šiuos klausimus:

• Kas naudos šį dokumentą? – Ar tai bus pirmą kartą naudojantis vartotojas, ar labiau pažengęs vartotojas?
• Kurioje vietoje vartotojas pasieks šį dokumentą? Ar jie ieško bendros ar papildomos informacijos apie įrankio galimybes, ar sprendimo konkrečiai problemai?
• Kokiu įrenginiu jie naudos? Jei tai mobilusis įrenginys, ar vaizdo įrašai yra pakankamai aiškūs?
• Kokie jų poreikiai ir lūkesčiai? Ar vartotojas pageidautų žiūrėti dinamišką vaizdo įrašą ar žiūrėti diagramą?

Kai suprasite savo auditoriją ir jų poreikius, galite pradėti kurti savo dokumentaciją. Pavyzdžiui, jei jūsų tikslinė grupė yra pradedantieji vartotojai, dokumentacija turėtų būti prieinama kiekviename žingsnyje, parašyta paprasta, lengvai suprantama kalba ir apimti išsamius nurodymus.

Atminkite, kad gerai organizuota dokumentacija ne tik padeda vartotojams suprasti produktą, bet ir taupo laiką, kurį jie galėjo praleisti ieškodami atsakymų į savo klausimus. Tai sumažina klientų nutekėjimą, t. y. procentinį rodiklį, kuriuo klientai nustoja prenumeruoti paslaugą.

Aiški komunikacija

Efektyvios produkto dokumentacijos kūrimas ne tik apie tinkamos komunikacijos formos pasirinkimą (pvz., vaizdo įrašai, vizualizacijos, žinių bazė), bet ir apie aiškų ir glaustą rašymą bei komunikavimą. Pagrindiniai efektyvios komunikacijos principai produkto dokumentacijoje yra šie:

• Naudokite paprastą kalbą – venkite techninės kalbos ir sudėtingų terminų. Pavyzdžiui, vietoj “inicijuoti projektą” galite sakyti “pradėti projektą”.
• Būkite konkretūs – pateikite pavyzdžių, kad padėtumėte vartotojams suprasti, kaip naudoti produktą. Pavyzdžiui, vietoj “leidžia pridėti komandos narius prie projekto” sakykite “pridėkite komandos narį prie projekto, spustelėdami žalią mygtuką projekto valdymo puslapio apačioje” ir pridėkite ekrano nuotrauką su vizualiu užuomina.
• Venkite pasyvaus balso – aktyvus balsas yra lengviau suprantamas ir skaitomas. Pavyzdžiui, vietoj “projektą gali pradėti vadovas” sakykite “vadovas gali pradėti projektą”.

Yra daug kitų principų, kurių reikia laikytis, tačiau svarbiausia prisiminti, kad efektyvi produkto dokumentacija turėtų būti suprantama vartotojams ir padėti jiems efektyviai naudoti produktą.

Vizualų naudojimas produkto dokumentacijoje

Vizualai, tokie kaip vaizdai, gifai, trumpi vaizdo įrašai, diagramos ir infografikai, gali labai pagerinti produkto dokumentacijos supratimą. Pavyzdžiui, ekrano nuotrauka, rodanti, kur yra “Pridėti komandos narį” mygtukas puslapyje, gali būti labai naudinga pirmą kartą naudojantiems vartotojams. Kurdamas dokumentaciją, taip pat naudokite aiškius antraštes ir paprastą šriftą, kad organizuotumėte tekstą.

Produkto dokumentacijos atnaujinimas ir palaikymas

Produkto dokumentacija nėra statiškas dokumentas. Ji turi būti reguliariai atnaujinama, kad atspindėtų pokyčius produkte. Reguliarūs atnaujinimai yra būtini, kad dokumentacija atliktų savo funkciją. Pavyzdžiui, jei pristatote naują funkciją savo projekto valdymo programinėje įrangoje, turėtumėte atnaujinti jos produkto dokumentaciją, kad tai atspindėtų.

Produkto dokumentacijos skelbimas ir platinimas

Produkto dokumentacijos skelbimas ir platinimas yra ne mažiau svarbus nei jos kūrimas. Turite užtikrinti, kad jūsų dokumentacija būtų lengvai prieinama vartotojams, nesvarbu, kur jie yra ar kokiu įrenginiu naudojasi. Pavyzdžiui, galite įkelti savo produkto dokumentaciją į savo svetainę arba siųsti ją tiesiogiai vartotojams el. paštu.

Geriausios dokumentų valdymo sistemos produktų vadovams

Produkto vadovai turi daug įrankių, kurie gali padėti jiems kurti ir valdyti produkto dokumentaciją. Populiarios sprendimų apima:

• Google Docs yra debesų paslauga dokumentams kurti ir redaguoti. Tai populiarus įrankis produktų vadovams, nes jį galima pasiekti bet kuriame įrenginyje ir juo gali naudotis keli komandos nariai.

• Firmbee yra išsamus projektų ir komandų valdymo įrankis, leidžiantis vartotojams atlikti užduotis iš bet kurios pasaulio vietos realiu laiku. Produkto vadovai gali lengvai organizuoti savo ir savo kolegų darbą, stebėti pažangą, kontroliuoti biudžetus ir vykdyti atrankos procesus.

• Notion yra užduočių ir projektų valdymo programa, kuri gali būti naudojama užduotims, pastaboms ir failams sekti. Notion yra populiari pasirinkimo galimybė produktų vadovams, nes ji yra lanksti ir gali būti pritaikyta.

• Zendesk Guide yra klientų aptarnavimo sprendimas, kuris gali būti naudojamas žinių bazės straipsniams kurti ir dalintis. Zendesk Guide yra populiarus pasirinkimas produktų vadovams, nes jis leidžia teikti pagalbą ir padėti klientams spręsti jų problemas.

Santrauka

Kuriant ir valdant produkto dokumentaciją, tai dažnai neįvertinta užduotis. Daugelis skaitmeninių produktų kūrėjų mano, kad gerai suprojektuotas produktas yra savaime suprantamas. Tačiau produkto dokumentacija turėtų būti daugiau nei tik vartotojo gidas.

Ji taip pat turėtų būti įrankis, kuris gali padėti didinti klientų sąmoningumą apie produktą ir analizuoti jų susidomėjimą naujomis funkcijomis, taip pat konkrečių straipsnių ar paaiškinimų peržiūrų skaičių. Tokia analizė padeda įmonėms geriau valdyti savo produktus ir gerinti vartotojų patirtį. Taigi verta skirti laiko ir pastangų kurti efektyvią produkto dokumentaciją, kuri gali tarnauti tiek jums, tiek jūsų vartotojams.

Jei jums patinka mūsų turinys, prisijunkite prie mūsų užimtų bičių bendruomenės Facebook, Twitter, LinkedIn, Instagram, YouTube, Pinterest, TikTok.