Bonjou, Habr! Non mwen se Lesha, mwen se yon analis sistèm pou youn nan ekip pwodwi Alfa-Bank la. Koulye a, mwen ap devlope yon nouvo bank sou entènèt pou antite legal ak antreprenè endividyèl.
Men, lè ou se yon analis, espesyalman nan yon kanal konsa, ou pa ka jwenn nenpòt kote san dokiman ak travay fèmen ak li. Ak dokimantasyon se yon bagay ki toujou soulve anpil kesyon. Poukisa aplikasyon entènèt la pa dekri? Poukisa spesifikasyon an endike ki jan sèvis la ta dwe travay, men li pa travay konsa ditou? Poukisa se sèlman de moun, youn nan yo te ekri li, ka konprann spesifikasyon la?
Sepandan, dokiman pa ka inyore pou rezon evidan. E pou rann lavi nou pi fasil, nou te deside evalye kalite dokimantasyon an. Ki jan egzakteman nou te fè sa a ak ki konklizyon nou te vini nan pi ba pase koupe a.
Kalite dokimantasyon
Pou m pa repete "New Internet Bank" plizyè douzèn fwa nan tèks la, mwen pral ekri NIB. Kounye a nou gen plis pase yon douzèn ekip k ap travay sou devlopman NIB pou antreprenè ak antite legal. Anplis, chak nan yo swa kreye pwòp dokiman pa yo pou yon nouvo sèvis oswa aplikasyon entènèt nan grafouyen, oswa fè chanjman nan yon sèl aktyèl la. Avèk apwòch sa a, èske dokimantasyon an nan prensip ka gen bon jan kalite segondè?
Ak pou detèmine kalite dokiman an, nou te idantifye twa karakteristik prensipal yo.
- Li dwe konplè. Sa a son pito kapitèn-tankou, men li enpòtan sonje. Li ta dwe dekri an detay tout eleman nan solisyon an aplike.
- Li dwe enpòtan. Sa vle di, koresponn ak aplikasyon aktyèl la nan solisyon an tèt li.
- Li ta dwe konprann. Se konsa, moun ki sèvi ak li konprann egzakteman ki jan solisyon an aplike.
Pou rezime - dokiman konplè, ajou ak konprann.
Опрос
Pou evalye kalite dokiman an, nou deside fè entèvyou ak moun ki travay dirèkteman avèk li: analis NIB. Yo te mande moun ki reponn yo evalye 10 deklarasyon dapre konplo a "Sou yon echèl soti nan 1 a 5 (konplètman dakò - konplètman dakò)."
Deklarasyon yo te reflete karakteristik dokiman kalitatif yo ak opinyon moun k ap fè sondaj yo konsènan dokiman NIB yo.
- Dokimantasyon pou aplikasyon NIB yo ajou e konplètman konsistan avèk aplikasyon yo.
- Aplikasyon aplikasyon NIB yo konplètman dokimante.
- Dokimantasyon pou aplikasyon NIB nesesè sèlman pou sipò fonksyonèl.
- Dokimantasyon pou aplikasyon NIB yo kounye a nan moman yo soumèt yo pou sipò fonksyonèl.
- Devlopè aplikasyon NIB yo sèvi ak dokiman pou konprann sa yo bezwen aplike.
- Gen ase dokiman pou aplikasyon NIB yo konprann kijan yo aplike.
- Mwen mete ajou dokimantasyon sou pwojè NIB san pèdi tan si yo finalize (pa ekip mwen an).
- Devlopè aplikasyon NIB yo revize dokiman yo.
- Mwen gen yon konpreyansyon klè sou fason pou prepare dokiman pou pwojè NIB yo.
- Mwen konprann ki lè pou m ekri/mete ajou dokiman pou pwojè NIB yo.
Li klè ke tou senpleman reponn "De 1 a 5" ta ka pa revele detay ki nesesè yo, kidonk yon moun ka kite yon kòmantè sou chak atik.
Nou te fè tout bagay sa yo atravè Corporate Slack - nou tou senpleman voye yon envitasyon bay analis sistèm yo pran yon sondaj. Te gen 15 analis (9 soti Moskou ak 6 soti nan Saint Petersburg). Apre sondaj la fini, nou te pwodwi yon nòt mwayèn pou chak nan 10 deklarasyon yo, ke nou te estandadize.
Sa a se sa ki te pase.
Sondaj la te montre ke byenke analis yo enkline yo kwè ke aplikasyon an nan aplikasyon NIB se konplètman dokimante, yo pa bay akò klè (0.2). Kòm yon egzanp espesifik, yo fè remake ke yon kantite baz done ak ke moun kap kriye nan solisyon ki egziste deja yo pa te kouvri pa dokiman. Pwomotè a kapab di analis la ke se pa tout bagay ki dokimante. Men, tèz la ke devlopè yo revize dokiman tou pa t 'resevwa inekivok sipò (0.33). Sa vle di, risk pou yo deskripsyon enkonplè nan solisyon aplike rete.
Relevans se pi fasil - byenke pa gen okenn akò klè ankò (0,13), analis yo toujou enkline yo konsidere dokiman an ki enpòtan. Kòmantè yo te pèmèt nou konprann ke pwoblèm ki gen enpòtans yo pi souvan nan devan pase nan mitan an. Sepandan, yo pa t ekri nou anyen sou sipò.
Kòm pou si wi ou non analis yo tèt yo konprann lè li nesesè yo ekri ak mete ajou dokiman, akò a te pi plis inifòm (1,33), ki gen ladan konsepsyon li yo (1.07). Ki sa ki te note isit la kòm yon enkonvenyan se mank de règ inifòm pou kenbe dokiman yo. Se poutèt sa, yo nan lòd yo pa vire sou "Ki moun ki ale nan forè a, ki moun ki vin bwa dife" mòd, yo dwe travay ki baze sou egzanp dokiman ki egziste deja. Pakonsekan, yon volonte itil se kreye yon estanda pou jesyon dokiman ak devlope modèl pou pati yo.
Dokimantasyon pou aplikasyon NIB yo kounye a nan moman yo soumèt pou sipò fonksyonèl (0.73). Sa a se konprann, paske youn nan kritè pou soumèt yon pwojè pou sipò fonksyonèl se dokiman ki ajou. Li se tou ase yo konprann aplikasyon an (0.67), byenke pafwa kesyon rete.
Men, sa ki repond yo pa t 'dakò ak (byen unaniment) se ke dokiman pou aplikasyon NIB, nan prensip, se sèlman nesesè pou sipò fonksyonèl (-1.53). Analis yo te mansyone pi souvan kòm konsomatè nan dokiman. Rès ekip la (devlopè) - anpil mwens souvan. Anplis, analis yo kwè ke devlopè yo pa sèvi ak dokiman yo konprann sa yo bezwen aplike, byenke pa unaniment (-0.06). Sa a, nan chemen an, tou espere nan kondisyon kote devlopman kòd ak ekri dokiman kontinye nan paralèl.
Ki sa ki liy anba a ak poukisa nou bezwen nimewo sa yo?
Pou amelyore kalite dokiman yo, nou deside fè bagay sa yo:
- Mande pwomotè a pou l revize dokiman ekri yo.
- Si sa posib, mete ajou dokiman yo nan yon fason apwopriye, devan an premye.
- Kreye epi adopte yon estanda pou dokimante pwojè NIB pou tout moun ka byen vit konprann ki eleman sistèm ak ki jan egzakteman yo ta dwe dekri. Oke, devlope modèl ki apwopriye yo.
Tout bagay sa yo ta dwe ede ogmante kalite dokiman yo nan yon nivo nouvo.
Omwen mwen espere sa.
Sous: www.habr.com