Kuidas mõõta dokumentatsiooni efektiivsust

autor ClickHelp - professionaalse abi autoritööriist

Tehniline kirjutamine ja kommunikatsioon hõlmab keeruka teabe edastamist kindlale sihtrühmale selguse ja täpsusega. Võtmesõnaks on siin kommunikatsioon, mis on kahepoolse suhtluse mõiste. Kuid tehnilise kirjutamise korral on adressaadi pool varjatud saladuses. Tehnikukirjutajatel on lõppkasutajate, nende kompetentsuse taseme ja vajaduste kohta sageli väga ebamäärane ettekujutus, kuna neil puuduvad kuulajate teadmised ja tagasiside. Kuid sihtrühma teadmiste selge mõistmine on oluline, et kohandada kirjutamist konkreetse sihtrühma vajadustega ja sõnumit õigesti edastada.

Selles artiklis keskendume mõõdikute kogumise viisidele, mida saaks edaspidi kasutada dokumentide kvaliteedi ja kasutajate rahulolu parandamiseks.

KASUTA VEEBI ANALÜÜTIKAT

Veebianalüütika on võimas instrument, mis võimaldab mõõta kasutajakogemust. Kõige põhilisema, kuid siiski kasuliku teabe kogumiseks oma sihtrühma kohta võite kasutada Google Analyticsit, Adobe Analyticsit või mõnda muud veebianalüüsi teenust. See pakub teile järgmisi mõõdikuid:

  • Kindlal lehel veedetud aeg.
  • Vaadatud lehtede arv külastuse kohta.
  • Lehe külastuste arv ja palju muud.

Näiteks on ClickHelpi tehnilises kirjutamisvahendis sisseehitatud statistikafunktsioon, mis võimaldab jälgida konkreetse teema või kogu projekti vaatamisstatistikat.

Veebianalüütika mõõdikuid kasutades saate teha teatud järeldusi selle kohta, kuidas kohandada dokumentatsiooni ja muuta see oma vaatajaskonna vajadustele vastavaks. Näiteks võite teada saada, milliseid teemasid vaadatakse kõige rohkem ja kui palju aega kasutajad nendel lehtedel veedavad. Nii et kui mõni teema on populaarne, kuid kasutajad veedavad seal liiga palju aega, piisavalt, et seda mitu korda lugeda, võib see tähendada, et seda teemat tuleb täiustada: võiksite selle ümber kirjutada lihtsas keeles, lisada ekraanipilte ja gife, kasutada vähem žargooni, muutke see selgemaks ja kokkuvõtlikumaks jne.

KASUTA KÜSITLUSI JA VAJUTUST

Teine viis kasutajadokumentatsiooni puuduste kohta lisateabe saamiseks on otse lõppkasutajatelt küsida, kas neil on konkreetse dokumendiga positiivne kogemus. Selleks vajate sisseehitatud tagasiside mehhanismi dokumentide igal abiteema lehel.

Soovitame teil kasutada lihtsat reageerimismehhanismi, nagu pöidla üles ja alla nupud. Näiteks sisaldab ClickHelp hinnangute aruande funktsiooni, mis kogub statistikat vastavalt järgmise vidina andmetele.

Täpsemat teavet saab koguda täitmisvormide kaudu, mis avanevad, kui kasutajad löövad pöidla allapoole nuppu. Nii saate lisateavet selle kohta, kas konkreetne teema vastas kasutajate vajadustele. Võite kasutada hüpikakent ka lühikese intervjuuga, mis ilmub siis, kui kasutajad üritavad lehelt lahkuda.

TEE KASUTATAVUSKATSETEID

Kahjuks annab tagasisidet vaid väike protsent kasutajaid ja negatiivse kogemuse korral jätab kommentaarid veelgi vähem. See tähendab, et uuringutel põhinevad järeldused ei ole alati esinduslikud. Nii et 3. võimalus on teha kasutatavuse testimine.

Jakob Nielseni sõnul on kasutatavuse uuringu läbiviimiseks ja usaldusväärsete tulemuste saamiseks vaja ainult 5 juhuslikku osalejat. Veelgi esinduslikuma statistika kogumiseks peate leidma viis osalejat, kes esindavad eri tüüpi dokumentatsiooni kasutajaid: arendajad, uued kasutajad, algajad kasutajad, asjatundlikud kasutajad ja nii edasi, sõltuvalt dokumenteeritud toote tüübist.

Selle asemel, et koondada ühele uuringule palju osalejaid, proovige teha väikese kasutajate arvuga mitu kasutatavuse testi. Mitmesugused testid, mis on läbi viidud väikese rühmaga inimestega, osutuvad palju kasulikumaks kui ühe uuringu tegemine suure hulga inimestega. Nii kogute rohkem andmeid ja tagasisidet ning teie ettevõte saavutab sama investeeritud raha eest rohkem.

ANALÜÜSIVABA PILETID JA KASUTAJATE FOORUMID

Teine viis dokumentatsiooni tõhususe mõõtmiseks on tugipiletite ja foorumilõikude uurimine. Kahjuks pole kumbki neist allikatest piisavalt informatiivne ja usaldusväärne, et muuta see kasutajate tagasiside esmaseks allikaks.

Tugiteenuste poole pöörduvad kasutajad ei kirjelda tavaliselt oma kogemusi dokumenteerimisega: kas nad tutvusid dokumentidega, mida nad otsisid ja kas nad on lahenduse leidnud. Kuid kui nad seda teevad, võimaldab see teil teada saada, kas konkreetne teema sisaldab kogu vajalikku teavet teema kohta või tuleks seda laiendada. Kui teema sisaldab vajalikku lahendust, kuid kasutajal ei õnnestu seda leida, peate kaaluma konkreetse teema või kogu dokumentatsiooni ülesehituse parandamist.

Tugipiletite ja kasutajafoorumite teabe analüüsimisel peate meeles pidama, et need kasutaja tagasiside allikad pakuvad ühepoolset pilti. Kui kasutajad on oma kogemustega dokumentidega rahul, ei võta nad ühendust tugimeeskonnaga ega jaga foorumites oma kogemusi.

JÄRELDUS

Erinevalt teistest kirjatüüpidest suhtleb tehniline kirjutamine erinevat tüüpi publikuga, mis sõltub dokumenteeritud tootest, selle funktsionaalsusest, selle niši iseärasustest, kuhu see kuulub. Veebimõõdikud, uuringud, intervjuud, kasutatavuse testid, tugipiletid ja kasutajafoorumid pakuvad koos mõõdikute komplekti, mis võimaldab mõõta tehnilise dokumentatsiooni ning selle konkreetsete teemade ja lõikude tõhusust. Mainitud allikate kvantitatiivne ja kvalitatiivne analüüs võimaldab teil leida võimalusi dokumentide kvaliteedi ja kasutajate rahulolu parandamiseks.

Õnn kaasa tehnilise kirjutamiskarjääriga!
Klõpsake nuppuHelpi meeskond
Autorite loomine, hostimine ja dokumentide üleandmine platvormide ja seadmete kaudu

Algselt avaldati saidil clickhelp.co.