Halo, Habr! Nami abdi Lesha, abdi analis sistem pikeun salah sahiji tim produk Alfa-Bank. Ayeuna kuring ngembangkeun bank online anyar pikeun badan hukum sareng pangusaha individu.
Sareng nalika anjeun analis, khususna dina saluran sapertos kitu, anjeun moal tiasa ka mana waé tanpa dokuméntasi sareng nutup karyana. Jeung dokuméntasi mangrupa hal anu salawasna raises loba patarosan. Naha aplikasi wéb henteu dijelaskeun? Naha spésifikasi nunjukkeun kumaha jasa éta kedah dianggo, tapi henteu tiasa dianggo sapertos kitu? Naha ngan ukur dua urang, salah sahiji anu nyeratna, tiasa ngartos spésifikasi?
Sanajan kitu, dokuméntasi teu bisa dipaliré alesan atra. Sarta sangkan hirup urang leuwih gampang, urang mutuskeun pikeun evaluate kualitas dokuméntasi. Kumaha kahayang urang ngalakukeun ieu sareng naon kacindekan anu urang sumping ka handap.
Kualitas dokuméntasi
Dina raraga teu ngulang "Bank Internet Anyar" sababaraha belasan kali dina téks, abdi bakal nulis NIB. Ayeuna kami ngagaduhan langkung ti belasan tim anu damel dina pamekaran NIB pikeun pangusaha sareng badan hukum. Leuwih ti éta, unggal sahijina boh nyieun dokuméntasi sorangan pikeun layanan anyar atawa aplikasi wéb ti scratch, atawa nyieun parobahan ka ayeuna. Kalayan pendekatan ieu, tiasa dokuméntasi dina prinsipna janten kualitas luhur?
Sareng pikeun nangtukeun kualitas dokuméntasi, kami parantos ngaidentipikasi tilu ciri utama.
- Kudu lengkep. Ieu hurung rada kawas kaptén, tapi hal anu penting pikeun dicatet. Éta kedah ngajelaskeun sacara rinci sadaya unsur tina solusi anu dilaksanakeun.
- Éta kedah relevan. Hartina, luyu jeung palaksanaan ayeuna solusi sorangan.
- Kudu kaharti. Sangkan jalma anu ngagunakeun éta ngartos persis kumaha solusina dilaksanakeun.
Pikeun nyimpulkeun - dokuméntasi lengkep, up-to-date sareng kaharti.
tatanyaan
Pikeun meunteun kualitas dokuméntasi, kami mutuskeun pikeun ngawawancara anu langsung damel sareng éta: analis NIB. Responden dipenta pikeun meunteun 10 pernyataan numutkeun skéma "Dina skala ti 1 nepi ka 5 (lengkep teu satuju - sagemblengna satuju)."
Pernyataan éta ngagambarkeun karakteristik dokuméntasi kualitatif sareng pendapat para kompiler survey ngeunaan dokumén NIB.
- Dokuméntasi pikeun aplikasi NIB nyaéta up to date sareng sapinuhna konsisten sareng palaksanaanna.
- Palaksanaan aplikasi NIB pinuh didokumentasikeun.
- Dokuméntasi pikeun aplikasi NIB ngan ukur diperyogikeun pikeun pangrojong fungsional.
- Dokuméntasi pikeun aplikasi NIB ayeuna aya dina waktos pangiriman pikeun dukungan fungsional.
- Pangembang aplikasi NIB nganggo dokuméntasi pikeun ngartos naon anu kedah dilaksanakeun.
- Aya cukup dokuméntasi pikeun aplikasi NIB ngartos kumaha aranjeunna dilaksanakeun.
- Kuring geuwat ngamutahirkeun dokuméntasi dina proyék NIB upami aranjeunna parantos réngsé (ku tim kuring).
- Pamekar aplikasi NIB marios dokuméntasi.
- Kuring boga pamahaman jelas ngeunaan kumaha carana nyiapkeun dokuméntasi pikeun proyék NIB.
- Kuring ngarti lamun nulis / ngamutahirkeun dokuméntasi pikeun proyék NIB.
Jelas yén ngan ukur ngajawab "Ti 1 dugi ka 5" tiasa waé henteu ngungkabkeun detil anu diperyogikeun, ku kituna hiji jalma tiasa masihan koméntar dina unggal item.
Kami ngalakukeun sadayana ieu ngalangkungan Slack perusahaan - kami ngan ukur ngirim uleman ka analis sistem pikeun nyandak survey. Aya 15 analis (9 ti Moscow jeung 6 ti St. Petersburg). Saatos survey réngsé, kami ngahasilkeun skor rata-rata pikeun tiap tina 10 pernyataan, anu teras kami standarkeun.
Ieu kajadian.
survey némbongkeun yén sanajan analis anu condong yakin yén palaksanaan aplikasi NIB pinuh documented, aranjeunna teu masihan perjangjian unambiguous (0.2). Salaku conto husus, aranjeunna nunjuk kaluar yén sajumlah database na antrian ti solusi aya teu katutupan ku dokuméntasi. Pamekar tiasa nyarioskeun ka analis yén henteu sadayana didokumentasikeun. Tapi tesis yén pamekar marios dokuméntasi ogé henteu nampi dukungan anu teu jelas (0.33). Hartina, résiko pedaran lengkep solusi dilaksanakeun tetep.
Relevansi leuwih gampang - sanajan aya deui euweuh perjangjian jelas (0,13), analis masih condong mertimbangkeun dokuméntasi relevan. Koméntar ngamungkinkeun urang ngartos yén masalah relevansi langkung sering di payun tibatan di tengah. Nanging, aranjeunna henteu nyerat nanaon ka kami ngeunaan ngadukung.
Sedengkeun pikeun naha analis sorangan ngartos lamun perlu nulis jeung ngamutahirkeun dokuméntasi, perjangjian éta leuwih seragam (1,33), kaasup desain na (1.07). Anu kacatet di dieu salaku kasulitan nyaéta kurangna aturan seragam pikeun ngajaga dokuméntasi. Ku alatan éta, dina urutan teu ngahurungkeun mode "Saha ka leuweung, saha meunang firewood", maranéhanana kudu digawé dumasar kana conto dokuméntasi aya. Lantaran kitu, kahayang anu mangpaat nyaéta nyiptakeun standar pikeun ngokolakeun dokumén sareng ngembangkeun témplat pikeun bagian-bagianna.
Dokuméntasi pikeun aplikasi NIB ayeuna dina waktos kiriman pikeun dukungan fungsional (0.73). Hal ieu kaharti, sabab salah sahiji kriteria pikeun ngirimkeun proyék pikeun rojongan fungsional nyaéta dokuméntasi up-to-date. Éta ogé cekap pikeun ngartos palaksanaan (0.67), sanaos kadang aya patarosan.
Tapi naon anu responden henteu satuju sareng (rada unanimously) éta dokuméntasi pikeun aplikasi NIB, prinsipna mah, ngan diperlukeun pikeun rojongan fungsional (-1.53). Analis sering disebatkeun salaku konsumen dokuméntasi. Sesa tim (pamekar) - loba kirang sering. Leuwih ti éta, analis yakin yén pamekar teu make dokuméntasi ngartos naon maranéhna kudu nerapkeun, sanajan teu unanimously (-0.06). Ku jalan kitu, ieu ogé dipiharep dina kaayaan dimana pamekaran kode sareng tulisan dokuméntasi lumangsung paralel.
Naon garis handap sarta naha urang peryogi angka ieu?
Pikeun ningkatkeun kualitas dokumén, kami mutuskeun pikeun ngalakukeun ieu:
- Tanya pamekar pikeun marios dokumén ditulis.
- Upami mungkin, update dokuméntasi dina waktosna, payun heula.
- Jieun sareng ngadopsi standar pikeun ngadokumentasikeun proyék NIB supados sadayana tiasa gancang ngartos elemen sistem mana sareng kumaha persisna anu kedah dijelaskeun. Nya, ngamekarkeun témplat anu pas.
Sadaya ieu kedah ngabantosan ningkatkeun kualitas dokumén ka tingkat anu énggal.
Sahenteuna kuring miharep kitu.
sumber: www.habr.com