Projekto dokumentacija arba kodėl reikia laukelių paskirties aprašo

Projekto dokumentacija. Jau vien pavadinimas skamba nuobodžiai. 😴 Rašyti ją irgi darbas ne iš įdomiausių. Ypač kai esi tas, kuris nori greičiau spręsti problemas, kurti naujas funkcijas ir išbandyti inovacijas.

Niekam nereikia dokumentacijos. Tol kol jos iš tiesų prireikia. Tada kai kyla klausimas “O tai ką šitas laukelis daro?”, jau būna per vėlu. Prikurta funkcionalumų, neuždokumentuota. Ir niekas neprisimena kas ir kaip.

Kokia problema?

Ir kokia čia problema, kad nieks nežino, kokia vienos ar kitos funkcijos ar laukelio paskirtis?

Tai reiškia, kad naudotojai nežino, kaip veikia sistema. Žymiai ilgiau trunka, kol išmokstama ją naudotis. Atsakymus galima rasti projekto dokumentacijoje (jeigu ji yra, tik knistis po pdf užtrunka gerokai ilgiau). Bet jeigu nėra nei jos, nei paaiškinamo tekstuko (vadinamojo tooltip) gaištamas laikas, netinkamai suvedamos formos.

Pvz., kokioje bendrinėje duomenų įvedimo formoje kur reikia įvesti „vardas, pavardė, el. p. adresas“, atrodo paskirtis savaime aiški. O štai jeigu reikia įvesti „Objekto ID“, “Klaidos  kodas“, “Reference #”, – ten painiavos ir gaišaties atsiras daugiau. Ar tai registrų centro numeris, ar registracijos kliento sistemoje ID, ar dar kažkas?

Šią problemą pajutau savo kailiu, kai pradėjau šį mėnesį laikinai dirbti projektų vadovu. Paliktas „dokumentacijos skolas“ mes ištaisysime. 😁

Kiekvienam mygtukui – paskirties paaiškinimas 

Pamokos ir patirtys. Įmonės standartų sąrašą papildome dar vienu punktu: kiekvienas vidinės sistemos duomenų įvedimo laukelis ar mygtukas privalo šalia turėti paaiškinamąją informaciją apie savo paskirtį (tooltip, popup ar pan. formatu).

Jei ir jūsų vidinėje ERP, CRM ar CMS sistemoje yra tokių „vaiduoklių“, paprašykite savo IT komandos paaiškinti. O geriausia, kad tas paaiškinimas atsirastų būtent ten, kur jo labiausiai ir reikia – projekto dokumentacijoje ir minimum šalia nežinomo įvesties laukelio. Nes ten vartotojui lengviausia ir greičiausia suprasti kas prie ko.