Helo, Habr! Fy enw i yw Lesha, rwy'n ddadansoddwr systemau ar gyfer un o dimau cynnyrch Alfa-Bank. Nawr rwy'n datblygu banc ar-lein newydd ar gyfer endidau cyfreithiol ac entrepreneuriaid unigol.
A phan fyddwch chi'n ddadansoddwr, yn enwedig mewn sianel o'r fath, ni allwch gyrraedd unrhyw le heb ddogfennaeth a gweithio'n agos ag ef. Ac mae dogfennaeth yn rhywbeth sydd bob amser yn codi llawer o gwestiynau. Pam nad yw'r cymhwysiad gwe wedi'i ddisgrifio? Pam mae'r fanyleb yn nodi sut y dylai'r gwasanaeth weithio, ond nid yw'n gweithio felly o gwbl? Pam mai dim ond dau berson, ac un ohonynt a'i ysgrifennodd, sy'n gallu deall y fanyleb?
Fodd bynnag, ni ellir anwybyddu dogfennaeth am resymau amlwg. Ac i wneud ein bywyd yn haws, fe benderfynon ni werthuso ansawdd y ddogfennaeth. Mae sut yn union y gwnaethom hyn a pha gasgliadau y daethom iddynt yn is na'r toriad.
Ansawdd dogfennaeth
Er mwyn peidio ag ailadrodd “Banc Rhyngrwyd Newydd” sawl dwsin o weithiau yn y testun, byddaf yn ysgrifennu NIB. Nawr mae gennym fwy na dwsin o dimau yn gweithio ar ddatblygu NIB ar gyfer entrepreneuriaid ac endidau cyfreithiol. Ar ben hynny, mae pob un ohonynt naill ai'n creu ei ddogfennaeth ei hun ar gyfer gwasanaeth newydd neu raglen we o'r dechrau, neu'n gwneud newidiadau i'r un presennol. Gyda'r dull hwn, a all y ddogfennaeth mewn egwyddor fod o ansawdd uchel?
Ac i bennu ansawdd y ddogfennaeth, rydym wedi nodi tair prif nodwedd.
- Rhaid iddo fod yn gyflawn. Mae hyn yn swnio braidd yn debyg i gapten, ond mae'n bwysig nodi. Dylai ddisgrifio'n fanwl bob elfen o'r datrysiad a weithredwyd.
- Rhaid iddo fod yn gyfredol. Hynny yw, yn cyfateb i weithrediad presennol yr ateb ei hun.
- Dylai fod yn ddealladwy. Er mwyn i'r sawl sy'n ei ddefnyddio ddeall yn union sut mae'r datrysiad yn cael ei roi ar waith.
I grynhoi - dogfennaeth gyflawn, gyfredol a dealladwy.
Cyfweliad
Er mwyn asesu ansawdd y ddogfennaeth, penderfynasom gyfweld â'r rhai sy'n gweithio'n uniongyrchol ag ef: dadansoddwyr NIB. Gofynnwyd i’r ymatebwyr werthuso 10 datganiad yn ôl y cynllun “Ar raddfa o 1 i 5 (anghytuno’n llwyr – cytuno’n llwyr).”
Roedd y datganiadau'n adlewyrchu nodweddion dogfennaeth ansoddol a barn casglwyr yr arolwg ynghylch dogfennau'r NIB.
- Mae'r ddogfennaeth ar gyfer ceisiadau NIB yn gyfredol ac yn gwbl gyson â'u gweithrediad.
- Mae gweithrediad ceisiadau NIB wedi'i ddogfennu'n llawn.
- Dim ond ar gyfer cymorth swyddogaethol y mae angen dogfennaeth ar gyfer ceisiadau NIB.
- Mae'r dogfennau ar gyfer ceisiadau NIB yn gyfredol ar adeg eu cyflwyno ar gyfer cymorth swyddogaethol.
- Mae datblygwyr cymwysiadau NIB yn defnyddio dogfennaeth i ddeall yr hyn y mae angen iddynt ei weithredu.
- Mae digon o ddogfennaeth i'r ceisiadau NIB ddeall sut y cânt eu gweithredu.
- Byddaf yn diweddaru dogfennaeth ar brosiectau NIB yn brydlon os cânt eu cwblhau (gan fy nhîm).
- Datblygwyr ceisiadau NIB yn adolygu dogfennaeth.
- Mae gen i ddealltwriaeth glir o sut i baratoi dogfennaeth ar gyfer prosiectau NIB.
- Rwy'n deall pryd i ysgrifennu/diweddaru dogfennaeth ar gyfer prosiectau NIB.
Mae’n amlwg efallai na fyddai ateb “O 1 i 5” yn datgelu’r manylion angenrheidiol, felly gallai person adael sylw ar bob eitem.
Gwnaethom hyn i gyd trwy Slack corfforaethol - yn syml, anfonwyd gwahoddiad i ddadansoddwyr systemau i wneud arolwg. Roedd 15 o ddadansoddwyr (9 o Moscow a 6 o St Petersburg). Ar ôl i'r arolwg gael ei gwblhau, cynhyrchwyd sgôr gyfartalog ar gyfer pob un o'r 10 datganiad, a safonwyd gennym wedyn.
Dyma beth ddigwyddodd.
Dangosodd yr arolwg, er bod dadansoddwyr yn dueddol o gredu bod gweithrediad ceisiadau NIB wedi'i ddogfennu'n llawn, nid ydynt yn rhoi cytundeb diamwys (0.2). Fel enghraifft benodol, gwnaethant dynnu sylw at y ffaith nad oedd nifer o gronfeydd data a chiwiau o atebion presennol wedi'u cwmpasu gan ddogfennaeth. Mae'r datblygwr yn gallu dweud wrth y dadansoddwr nad yw popeth wedi'i ddogfennu. Ond ni chafodd y traethawd ymchwil y mae datblygwyr yn ei adolygu ychwaith gefnogaeth ddigamsyniol (0.33). Hynny yw, erys y risg o ddisgrifiad anghyflawn o atebion a weithredwyd.
Mae perthnasedd yn haws - er nad oes cytundeb clir eto (0,13), mae dadansoddwyr yn dal i fod yn dueddol o ystyried y ddogfennaeth berthnasol. Caniataodd y sylwadau i ni ddeall bod problemau perthnasedd yn amlach yn y blaen nag yn y canol. Fodd bynnag, ni wnaethant ysgrifennu unrhyw beth atom am gefnogaeth.
O ran a yw'r dadansoddwyr eu hunain yn deall pryd mae angen ysgrifennu a diweddaru dogfennaeth, roedd y cytundeb yn llawer mwy unffurf (1,33), gan gynnwys ei ddyluniad (1.07). Yr hyn a nodwyd yma fel anghyfleustra oedd diffyg rheolau unffurf ar gyfer cynnal dogfennaeth. Felly, er mwyn peidio â throi ar y modd "Pwy sy'n mynd i'r goedwig, pwy sy'n cael coed tân", mae'n rhaid iddynt weithio yn seiliedig ar enghreifftiau o ddogfennaeth sy'n bodoli eisoes. Felly, dymuniad defnyddiol yw creu safon ar gyfer rheoli dogfennau a datblygu templedi ar gyfer eu rhannau.
Mae'r dogfennau ar gyfer ceisiadau NIB yn gyfredol ar adeg eu cyflwyno ar gyfer cymorth swyddogaethol (0.73). Mae hyn yn ddealladwy, oherwydd un o'r meini prawf ar gyfer cyflwyno prosiect ar gyfer cymorth swyddogaethol yw'r ddogfennaeth gyfredol. Mae hefyd yn ddigon deall y gweithredu (0.67), er bod cwestiynau'n parhau weithiau.
Ond yr hyn nad oedd yr ymatebwyr yn cytuno ag ef (yn eithaf unfrydol) oedd bod angen dogfennaeth ar gyfer ceisiadau NIB, mewn egwyddor, ar gyfer cymorth swyddogaethol yn unig (-1.53). Crybwyllwyd dadansoddwyr amlaf fel defnyddwyr dogfennaeth. Mae gweddill y tîm (datblygwyr) - yn llawer llai aml. Ar ben hynny, mae dadansoddwyr yn credu nad yw datblygwyr yn defnyddio dogfennaeth i ddeall yr hyn y mae angen iddynt ei weithredu, er nad yn unfrydol (-0.06). Mae hyn, gyda llaw, hefyd i'w ddisgwyl mewn amodau lle mae datblygu cod ac ysgrifennu dogfennaeth yn mynd rhagddo ochr yn ochr.
Beth yw'r llinell waelod a pham mae angen y niferoedd hyn arnom?
Er mwyn gwella ansawdd y dogfennau, penderfynwyd gwneud y canlynol:
- Gofynnwch i'r datblygwr adolygu dogfennau ysgrifenedig.
- Os yn bosibl, diweddarwch y ddogfennaeth mewn modd amserol, blaenwch yn gyntaf.
- Creu a mabwysiadu safon ar gyfer dogfennu prosiectau NIB fel y gall pawb ddeall yn gyflym pa elfennau system a sut yn union y dylid eu disgrifio. Wel, datblygwch dempledi priodol.
Dylai hyn oll helpu i godi ansawdd dogfennau i lefel newydd.
O leiaf dwi'n gobeithio.
Ffynhonnell: hab.com