Përshëndetje, Habr! Emri im është Lesha, unë jam një analist i sistemeve për një nga ekipet e produkteve të Alfa-Bank. Tani po zhvilloj një bankë të re online për persona juridikë dhe sipërmarrës individualë.
Dhe kur je analist, sidomos në një kanal të tillë, nuk mund të arrish askund pa dokumentacion dhe punë të ngushtë me të. Dhe dokumentacioni është diçka që ngre gjithmonë shumë pyetje. Pse nuk përshkruhet aplikacioni në internet? Pse specifikimi tregon se si duhet të funksionojë shërbimi, por nuk funksionon aspak kështu? Pse vetëm dy persona, njëri prej të cilëve e ka shkruar, mund ta kuptojnë specifikimin?
Sidoqoftë, dokumentacioni nuk mund të injorohet për arsye të dukshme. Dhe për ta bërë jetën tonë më të lehtë, vendosëm të vlerësojmë cilësinë e dokumentacionit. Se si saktësisht e bëmë këtë dhe në cilat përfundime arritëm është më poshtë.
Cilësia e dokumentacionit
Për të mos përsëritur "New Internet Bank" disa dhjetëra herë në tekst, do të shkruaj NIB. Tani kemi më shumë se një duzinë ekipe që punojnë në zhvillimin e NIB për sipërmarrësit dhe personat juridikë. Për më tepër, secila prej tyre ose krijon dokumentacionin e vet për një shërbim të ri ose aplikacion në ueb nga e para, ose bën ndryshime në atë aktual. Me këtë qasje, a mund të jetë në parim dokumentacioni i cilësisë së lartë?
Dhe për të përcaktuar cilësinë e dokumentacionit, ne kemi identifikuar tre karakteristika kryesore.
- Duhet të jetë i plotë. Kjo tingëllon si kapiten, por është e rëndësishme të theksohet. Ai duhet të përshkruajë në detaje të gjithë elementët e zgjidhjes së zbatuar.
- Duhet të jetë relevant. Kjo do të thotë, korrespondojnë me zbatimin aktual të vetë zgjidhjes.
- Duhet të jetë e kuptueshme. Kështu që personi që e përdor atë të kuptojë saktësisht se si zbatohet zgjidhja.
Për ta përmbledhur - dokumentacion i plotë, i përditësuar dhe i kuptueshëm.
Опрос
Për të vlerësuar cilësinë e dokumentacionit, vendosëm të intervistojmë ata që punojnë drejtpërdrejt me të: analistët e NIB. Të anketuarve iu kërkua të vlerësonin 10 deklarata sipas skemës "Në një shkallë nga 1 në 5 (plotësisht nuk pajtohem - plotësisht dakord)."
Deklaratat pasqyronin karakteristikat e dokumentacionit cilësor dhe opinionin e hartuesve të anketës në lidhje me dokumentet NIB.
- Dokumentacioni për aplikacionet NIB është i përditësuar dhe plotësisht në përputhje me zbatimin e tyre.
- Zbatimi i aplikacioneve NIB është plotësisht i dokumentuar.
- Dokumentacioni për aplikacionet NIB nevojitet vetëm për mbështetje funksionale.
- Dokumentacioni për aplikacionet NIB është aktual në momentin e paraqitjes së tyre për mbështetje funksionale.
- Zhvilluesit e aplikacioneve NIB përdorin dokumentacion për të kuptuar se çfarë duhet të zbatojnë.
- Ka mjaft dokumentacion që aplikacionet NIB të kuptojnë se si zbatohen.
- Unë përditësoj menjëherë dokumentacionin për projektet NIB nëse ato janë finalizuar (nga ekipi im).
- Zhvilluesit e aplikacioneve NIB shqyrtojnë dokumentacionin.
- Unë kam një kuptim të qartë se si të përgatis dokumentacionin për projektet NIB.
- Unë e kuptoj kur të shkruaj/përditësoj dokumentacionin për projektet NIB.
Është e qartë se përgjigjja e thjeshtë "Nga 1 në 5" mund të mos zbulojë detajet e nevojshme, kështu që një person mund të lërë një koment për çdo artikull.
Ne e bëmë të gjithë këtë përmes korporatës Slack - thjesht dërguam një ftesë për analistët e sistemit për të marrë një anketë. Ishin 15 analistë (9 nga Moska dhe 6 nga Shën Petersburg). Pasi sondazhi u përfundua, ne krijuam një rezultat mesatar për secilën nga 10 deklaratat, të cilat më pas i standardizuam.
Kjo është ajo që ndodhi.
Anketa tregoi se megjithëse analistët janë të prirur të besojnë se zbatimi i aplikacioneve NIB është plotësisht i dokumentuar, ata nuk japin një marrëveshje të qartë (0.2). Si shembull specifik, ata theksuan se një numër i bazave të të dhënave dhe radhëve nga zgjidhjet ekzistuese nuk mbuloheshin nga dokumentacioni. Zhvilluesi është në gjendje t'i tregojë analistit se jo gjithçka është e dokumentuar. Por teza që zhvilluesit shqyrtojnë dokumentacionin gjithashtu nuk mori mbështetje të qartë (0.33). Pra, rreziku i përshkrimit jo të plotë të zgjidhjeve të zbatuara mbetet.
Rëndësia është më e lehtë - megjithëse nuk ka përsëri një marrëveshje të qartë (0,13), analistët janë ende të prirur ta konsiderojnë dokumentacionin të rëndësishëm. Komentet na lejuan të kuptojmë se problemet me rëndësi janë më shpesh në pjesën e përparme sesa në mes. Megjithatë, ata nuk na shkruan asgjë për mbështetjen.
Sa i përket faktit nëse vetë analistët e kuptojnë kur është e nevojshme të shkruhet dhe përditësohet dokumentacioni, marrëveshja ishte shumë më uniforme (1,33), përfshirë modelin e saj (1.07). Ajo që u vu re këtu si shqetësim ishte mungesa e rregullave uniforme për mbajtjen e dokumentacionit. Prandaj, për të mos aktivizuar modalitetin "Kush shkon në pyll, kush merr dru zjarri", ata duhet të punojnë bazuar në shembuj të dokumentacionit ekzistues. Prandaj, një dëshirë e dobishme është krijimi i një standardi për menaxhimin e dokumenteve dhe zhvillimi i shablloneve për pjesët e tyre.
Dokumentacioni për aplikacionet NIB është aktual në momentin e paraqitjes për mbështetje funksionale (0.73). Kjo është e kuptueshme, sepse një nga kriteret për paraqitjen e një projekti për mbështetje funksionale është dokumentacioni i përditësuar. Është gjithashtu e mjaftueshme për të kuptuar zbatimin (0.67), megjithëse ndonjëherë mbeten pyetje.
Por ajo që të anketuarit nuk u pajtuan (mjaft unanimisht) ishte se dokumentacioni për aplikacionet NIB, në parim, nevojitet vetëm për mbështetje funksionale (-1.53). Analistët përmendeshin më shpesh si konsumatorë të dokumentacionit. Pjesa tjetër e ekipit (zhvilluesit) - shumë më rrallë. Për më tepër, analistët besojnë se zhvilluesit nuk përdorin dokumentacion për të kuptuar se çfarë duhet të zbatojnë, megjithëse jo njëzëri (-0.06). Kjo, meqë ra fjala, pritet edhe në kushtet kur zhvillimi i kodit dhe shkrimi i dokumentacionit ecin paralelisht.
Cili është përfundimi dhe pse na duhen këto shifra?
Për të përmirësuar cilësinë e dokumenteve, vendosëm të bëjmë sa vijon:
- Kërkojini zhvilluesit të rishikojë dokumentet e shkruara.
- Nëse është e mundur, përditësoni dokumentacionin në kohën e duhur, së pari.
- Krijoni dhe miratoni një standard për dokumentimin e projekteve NIB në mënyrë që të gjithë të kuptojnë shpejt se cilët elementë të sistemit dhe si duhet të përshkruhen saktësisht. Epo, zhvilloni shabllone të përshtatshme.
E gjithë kjo duhet të ndihmojë në ngritjen e cilësisë së dokumenteve në një nivel të ri.
Të paktën kështu shpresoj.
Burimi: www.habr.com