Hello, Habr! Jisimni Lesha, jiena analista tas-sistemi għal wieħed mit-timijiet tal-prodotti tal-Alfa-Bank. Issa qed niżviluppa bank ġdid onlajn għal entitajiet legali u intraprendituri individwali.
U meta tkun analista, speċjalment f'tali kanal, ma tistax tasal imkien mingħajr dokumentazzjoni u taħdem mill-qrib magħha. U d-dokumentazzjoni hija xi ħaġa li dejjem tqajjem ħafna mistoqsijiet. Għaliex l-applikazzjoni tal-web mhix deskritta? Għaliex l-ispeċifikazzjoni tindika kif is-servizz għandu jaħdem, iżda ma taħdimx hekk? Għaliex huwa li żewġ persuni biss, li waħda minnhom kitbuha, jistgħu jifhmu l-ispeċifikazzjoni?
Madankollu, id-dokumentazzjoni ma tistax tiġi injorata għal raġunijiet ovvji. U biex nagħmlu ħajjitna aktar faċli, iddeċidejna li nevalwaw il-kwalità tad-dokumentazzjoni. Kif eżattament għamilna dan u liema konklużjonijiet wasalna huwa taħt il-qatgħa.
Kwalità tad-dokumentazzjoni
Sabiex ma nirrepetix "New Internet Bank" diversi għexieren ta 'drabi fit-test, se nikteb NIB. Issa għandna aktar minn tużżana timijiet li jaħdmu fuq l-iżvilupp ta 'NIB għal intraprendituri u entitajiet legali. Barra minn hekk, kull wieħed minnhom jew joħloq id-dokumentazzjoni tiegħu stess għal servizz ġdid jew applikazzjoni tal-web mill-bidu nett, jew jagħmel bidliet għal dak attwali. B'dan l-approċċ, id-dokumentazzjoni tista' fil-prinċipju tkun ta' kwalità għolja?
U biex tiddetermina l-kwalità tad-dokumentazzjoni, identifikajna tliet karatteristiċi ewlenin.
- Għandu jkun komplut. Dan ħsejjes pjuttost bħal kaptan, iżda huwa importanti li wieħed jinnota. Għandha tiddeskrivi fid-dettall l-elementi kollha tas-soluzzjoni implimentata.
- Għandu jkun rilevanti. Jiġifieri, jikkorrispondu għall-implimentazzjoni attwali tas-soluzzjoni nnifisha.
- Għandu jinftiehem. Sabiex il-persuna li tużaha tifhem eżatt kif is-soluzzjoni hija implimentata.
Fil-qosor - dokumentazzjoni kompluta, aġġornata u li tinftiehem.
Poll
Biex nevalwaw il-kwalità tad-dokumentazzjoni, iddeċidejna li nintervistaw lil dawk li jaħdmu direttament magħha: analisti tal-NIB. Dawk li wieġbu ntalbu jevalwaw 10 dikjarazzjonijiet skont l-iskema "Fuq skala minn 1 sa 5 (ma jaqblux għal kollox - naqbel kompletament)."
Id-dikjarazzjonijiet irriflettew il-karatteristiċi tad-dokumentazzjoni kwalitattiva u l-opinjoni tal-kompilaturi tal-istħarriġ dwar id-dokumenti tal-NIB.
- Id-dokumentazzjoni għall-applikazzjonijiet NIB hija aġġornata u kompletament konsistenti mal-implimentazzjoni tagħhom.
- L-implimentazzjoni tal-applikazzjonijiet NIB hija dokumentata bis-sħiħ.
- Id-dokumentazzjoni għall-applikazzjonijiet NIB hija meħtieġa biss għall-appoġġ funzjonali.
- Id-dokumentazzjoni għall-applikazzjonijiet NIB hija attwali fil-ħin tas-sottomissjoni tagħhom għall-appoġġ funzjonali.
- L-iżviluppaturi tal-applikazzjonijiet NIB jużaw id-dokumentazzjoni biex jifhmu dak li għandhom bżonn jimplimentaw.
- Hemm biżżejjed dokumentazzjoni għall-applikazzjonijiet NIB biex jifhmu kif huma implimentati.
- Jiena naġġorna minnufih id-dokumentazzjoni dwar il-proġetti tal-NIB jekk jiġu ffinalizzati (mit-tim tiegħi).
- L-iżviluppaturi tal-applikazzjoni tal-NIB jirrevedu d-dokumentazzjoni.
- Għandi fehim ċar ta' kif nipprepara d-dokumentazzjoni għal proġetti NIB.
- Nifhem meta nikteb/taġġorna d-dokumentazzjoni għal proġetti NIB.
Huwa ċar li sempliċiment twieġeb "Minn 1 sa 5" jista 'ma jiżvelax id-dettalji meħtieġa, għalhekk persuna tista' tħalli kumment fuq kull oġġett.
Dan kollu għamilna permezz ta’ Slack korporattiv – sempliċement bgħatna stedina lill-analisti tas-sistema biex jagħmlu stħarriġ. Kien hemm 15-il analista (9 minn Moska u 6 minn San Pietruburgu). Wara li tlesta l-istħarriġ, aħna iġġeneraw punteġġ medju għal kull waħda mill-10 dikjarazzjonijiet, li mbagħad istandardizzajna.
Dan huwa dak li ġara.
L-istħarriġ wera li għalkemm l-analisti huma inklinati li jemmnu li l-implimentazzjoni tal-applikazzjonijiet NIB hija dokumentata bis-sħiħ, ma jagħtux qbil mhux ambigwu (0.2). Bħala eżempju speċifiku, huma rrimarkaw li għadd ta' databases u kjuwijiet minn soluzzjonijiet eżistenti ma kinux koperti mid-dokumentazzjoni. L-iżviluppatur huwa kapaċi jgħid lill-analista li mhux kollox huwa dokumentat. Iżda t-teżi li l-iżviluppaturi jirrevedu d-dokumentazzjoni wkoll ma rċevietx appoġġ inekwivoku (0.33). Jiġifieri, ir-riskju ta 'deskrizzjoni mhux kompluta ta' soluzzjonijiet implimentati jibqa '.
Ir-rilevanza hija aktar faċli - għalkemm għal darb'oħra m'hemm l-ebda ftehim ċar (0,13), l-analisti xorta huma inklinati li jqisu d-dokumentazzjoni rilevanti. Il-kummenti ppermettew li nifhmu li l-problemi b'rilevanza huma aktar spiss fuq quddiem milli fin-nofs. Madankollu, huma ma kitbuna xejn dwar l-appoġġ.
Fir-rigward ta 'jekk l-analisti nfushom jifhmux meta jkun meħtieġ li tikteb u taġġorna d-dokumentazzjoni, il-ftehim kien ħafna aktar uniformi (1,33), inkluż id-disinn tiegħu (1.07). Dak li ġie nnutat hawn bħala inkonvenjent kien in-nuqqas ta’ regoli uniformi għaż-żamma tad-dokumentazzjoni. Għalhekk, sabiex ma jixgħelx il-mod "Min imur fil-foresta, min jieħu l-ħatab", iridu jaħdmu abbażi ta 'eżempji ta' dokumentazzjoni eżistenti. Għalhekk, xewqa utli hija li jinħoloq standard għall-ġestjoni tad-dokumenti u jiġu żviluppati mudelli għall-partijiet tagħhom.
Id-dokumentazzjoni għall-applikazzjonijiet NIB hija attwali fil-ħin tas-sottomissjoni għall-appoġġ funzjonali (0.73). Dan jista 'jinftiehem, minħabba li wieħed mill-kriterji għas-sottomissjoni ta' proġett għal appoġġ funzjonali huwa dokumentazzjoni aġġornata. Huwa wkoll biżżejjed li wieħed jifhem l-implimentazzjoni (0.67), għalkemm xi drabi jibqgħu mistoqsijiet.
Iżda dak li wieġbu ma qablux miegħu (pjuttost unanimu) kien li d-dokumentazzjoni għall-applikazzjonijiet NIB, fil-prinċipju, hija meħtieġa biss għal appoġġ funzjonali (-1.53). L-analisti kienu jissemmew l-aktar bħala konsumaturi tad-dokumentazzjoni. Il-bqija tat-tim (iżviluppaturi) - ħafna inqas spiss. Barra minn hekk, l-analisti jemmnu li l-iżviluppaturi ma jużawx dokumentazzjoni biex jifhmu dak li għandhom bżonn jimplimentaw, għalkemm mhux b'mod unanimu (-0.06). Dan, mill-mod, huwa mistenni wkoll f'kundizzjonijiet fejn l-iżvilupp tal-kodiċi u l-kitba tad-dokumentazzjoni jipproċedu b'mod parallel.
X'inhu l-aħħar linja u għaliex għandna bżonn dawn in-numri?
Biex intejbu l-kwalità tad-dokumenti, iddeċidejna li nagħmlu dan li ġej:
- Staqsi lill-iżviluppatur biex jirrevedi dokumenti bil-miktub.
- Jekk possibbli, aġġorna d-dokumentazzjoni fil-ħin, l-ewwel quddiem.
- Oħloq u adotta standard għad-dokumentazzjoni ta' proġetti NIB sabiex kulħadd ikun jista' jifhem malajr liema elementi tas-sistema u kif għandhom jiġu deskritti eżattament. Ukoll, tiżviluppa mudelli xierqa.
Dan kollu għandu jgħin biex jgħolli l-kwalità tad-dokumenti għal livell ġdid.
Mill-inqas nittama li hekk.
Sors: www.habr.com