Сайн уу, Хабр! Намайг Леша гэдэг, би Альфа-Банкны бүтээгдэхүүний нэг багийн системийн шинжээч. Одоо би хуулийн этгээд, хувиараа бизнес эрхлэгчдэд зориулсан шинэ онлайн банк боловсруулж байна.
Та шинжээч байхдаа, ялангуяа ийм сувагт бичиг баримтгүй, нягт хамтран ажиллахгүйгээр хаашаа ч хүрч чадахгүй. Мөн бичиг баримт нь үргэлж олон асуултыг дагуулдаг зүйл юм. Яагаад вэб програмыг тайлбарлаагүй байна вэ? Үйлчилгээ хэрхэн ажиллах ёстойг техникийн үзүүлэлт яагаад зааж өгсөн байдаг, гэхдээ энэ нь огт ажиллахгүй байна вэ? Яагаад нэг нь бичсэн хоёрхон хүн техникийн үзүүлэлтийг ойлгодог юм бэ?
Гэсэн хэдий ч тодорхой шалтгааны улмаас баримт бичгийг үл тоомсорлож болохгүй. Мөн бидний амьдралыг хөнгөвчлөхийн тулд бид баримт бичгийн чанарыг үнэлэхээр шийдсэн. Бид үүнийг яг яаж хийж, ямар дүгнэлтэд хүрсэн бэ гэдэг нь огтлолтоос доогуур байгаа.
Баримт бичгийн чанар
Текстэд "Шинэ интернет банк" гэж хэдэн арван удаа давтахгүйн тулд би NIB бичнэ. Одоо бид бизнес эрхлэгчид болон хуулийн этгээдэд зориулсан NIB боловсруулах чиглэлээр арав гаруй баг ажиллаж байна. Түүнчлэн, тус бүр нь шинэ үйлчилгээ эсвэл вэб програмд зориулж өөрийн баримт бичгийг эхнээс нь бий болгодог, эсвэл одоогийнхдоо өөрчлөлт оруулдаг. Энэ аргын тусламжтайгаар баримт бичиг нь зарчмын хувьд өндөр чанартай байж чадах уу?
Мөн баримт бичгийн чанарыг тодорхойлохын тулд бид гурван үндсэн шинж чанарыг тодорхойлсон.
- Энэ нь бүрэн дүүрэн байх ёстой. Энэ нь ахмад шиг сонсогдож байгаа ч анхаарах нь чухал. Энэ нь хэрэгжүүлсэн шийдлийн бүх элементүүдийг нарийвчлан тайлбарлах ёстой.
- Энэ нь одоогийн байх ёстой. Өөрөөр хэлбэл, уг шийдлийн одоогийн хэрэгжилттэй тохирч байна.
- Энэ нь ойлгомжтой байх ёстой. Үүнийг ашиглаж байгаа хүн уг шийдэл хэрхэн хэрэгжиж байгааг ойлгохын тулд.
Дүгнэж хэлэхэд - бүрэн, шинэчлэгдсэн, ойлгомжтой баримт бичиг.
Санал асуулга
Баримт бичгийн чанарыг үнэлэхийн тулд бид түүнтэй шууд ажилладаг хүмүүстэй ярилцлага хийхээр шийдсэн: NIB-ийн шинжээчид. Судалгаанд оролцогчдоос 10 мэдэгдлийг "1-ээс 5 хүртэлх оноогоор (бүрэн санал нийлэхгүй - бүрэн санал нийлж байна)" схемийн дагуу үнэлэхийг хүссэн.
Энэхүү мэдэгдэлд чанарын баримт бичгийн шинж чанар, NIB баримт бичгийн талаархи судалгааг эмхэтгэгчдийн санал бодлыг тусгасан болно.
- NIB өргөдлийн бичиг баримт нь шинэчлэгдсэн бөгөөд хэрэгжилттэй бүрэн нийцдэг.
- NIB програмуудын хэрэгжилтийг бүрэн баримтжуулсан болно.
- NIB програмын баримт бичиг нь зөвхөн функциональ дэмжлэг үзүүлэхэд шаардлагатай.
- NIB өргөдлийн бичиг баримтууд нь функциональ дэмжлэг авахаар ирүүлсэн үед одоо байгаа.
- NIB програм хөгжүүлэгчид юу хэрэгжүүлэх ёстойгоо ойлгохын тулд баримт бичгийг ашигладаг.
- NIB програмууд хэрхэн хэрэгжиж байгааг ойлгоход хангалттай баримт бичиг байдаг.
- Би NIB төслүүдийн баримт бичгийг (миний баг) эцэслэн шийдвэрлэсэн тохиолдолд нэн даруй шинэчилдэг.
- NIB програм хөгжүүлэгчид баримт бичгийг хянадаг.
- Би NIB төслүүдийн баримт бичгийг хэрхэн бэлтгэх талаар тодорхой ойлголттой болсон.
- NIB төслүүдийн баримт бичгийг хэзээ бичих/шинэчлэхийг би ойлгож байна.
"1-ээс 5 хүртэл" гэж хариулснаар шаардлагатай нарийн ширийн зүйлийг олж харахгүй байх нь ойлгомжтой, тиймээс хүн зүйл бүр дээр сэтгэгдэл үлдээх боломжтой.
Бид энэ бүгдийг корпорацийн Slack-ээр дамжуулан хийсэн - бид зүгээр л системийн шинжээчдэд санал асуулга авах урилга илгээсэн. 15 шинжээч (Москвагаас 9, Санкт-Петербургээс 6) байсан. Судалгааг дуусгасны дараа бид 10 мэдэгдэл тус бүрийн дундаж оноог гаргаж, дараа нь стандартчилсан.
Ийм зүйл болсон.
Шинжээчид NIB өргөдлийн хэрэгжилтийг бүрэн баримтжуулсан гэж үзэх хандлагатай байгаа хэдий ч тэд хоёрдмол утгагүй санал нийлэхгүй байна (0.2). Тодорхой жишээ болгон тэд хэд хэдэн мэдээллийн сан, одоо байгаа шийдлүүдийн дараалал нь баримт бичигт хамрагдаагүй болохыг онцолсон. Хөгжүүлэгч нь бүх зүйлийг баримтжуулаагүй гэдгийг шинжээчдэд хэлэх боломжтой. Гэхдээ хөгжүүлэгчид баримт бичгийг хянадаг дипломын ажил нь тодорхой дэмжлэг аваагүй (0.33). Өөрөөр хэлбэл, хэрэгжүүлсэн шийдлүүдийг бүрэн бус тайлбарлах эрсдэл хэвээр байна.
Хамаарал нь илүү хялбар байдаг - хэдийгээр тодорхой тохиролцоо байхгүй (0,13) боловч шинжээчид баримт бичгийг хамааралтай гэж үзэх хандлагатай хэвээр байна. Тайлбарууд нь хамааралтай асуудлууд дундаас илүү урд талд байдаг гэдгийг ойлгох боломжийг бидэнд олгосон. Гэсэн хэдий ч тэд бидэнд дэмжлэг үзүүлэх талаар юу ч бичээгүй.
Баримт бичгийг бичих, шинэчлэх шаардлагатайг шинжээчид өөрсдөө ойлгож байгаа эсэх талаар гэрээ нь илүү жигд (1,33), түүний дотор загвар (1.07) байсан. Энд нэг таагүй зүйл гэж тэмдэглэсэн зүйл бол баримт бичиг хөтлөх нэгдсэн дүрэм байхгүй байсан. Тиймээс “Хэн ойд явж, хэн түлээ авдаг” горимыг асаахгүйн тулд одоо байгаа баримт бичгийн жишээн дээр үндэслэн ажиллах ёстой. Тиймээс баримт бичгийн менежментийн стандартыг бий болгож, тэдгээрийн хэсгүүдийн загваруудыг боловсруулах нь ашигтай хүсэл юм.
NIB өргөдлийн бичиг баримтууд нь функциональ дэмжлэг үзүүлэх үед (0.73) одоо байгаа. Энэ нь ойлгомжтой, учир нь функциональ дэмжлэг үзүүлэх төсөл ирүүлэх шалгууруудын нэг нь шинэчилсэн баримт бичиг юм. Энэ нь хэрэгжилтийг ойлгоход хангалттай (0.67), гэхдээ заримдаа асуултууд үлддэг.
Гэвч судалгаанд оролцогчдын санал нийлэхгүй байгаа зүйл бол NIB програмын баримт бичиг нь зарчмын хувьд зөвхөн функциональ дэмжлэг үзүүлэхэд шаардлагатай (-1.53). Баримт бичгийн хэрэглэгчид гэж шинжээчид ихэвчлэн дурдагддаг. Багийн үлдсэн хэсэг (хөгжүүлэгчид) - хамаагүй бага байдаг. Түүгээр ч барахгүй шинжээчид хөгжүүлэгчид санал нэгтэй биш ч (-0.06) хэрэгжүүлэх ёстой зүйлээ ойлгохын тулд баримт бичгийг ашигладаггүй гэж үздэг. Дашрамд хэлэхэд, код боловсруулах, баримт бичгийг бичих нь зэрэгцэн явагдаж байгаа нөхцөлд үүнийг бас хүлээж байна.
Хамгийн гол нь юу вэ, яагаад бидэнд эдгээр тоо хэрэгтэй байна вэ?
Баримт бичгийн чанарыг сайжруулахын тулд бид дараахь зүйлийг хийхээр шийдсэн.
- Хөгжүүлэгчээс бичсэн баримт бичгүүдийг шалгахыг хүс.
- Боломжтой бол эхлээд баримт бичгийг цаг тухайд нь шинэчил.
- NIB төслүүдийг баримтжуулах стандартыг бий болгож, баталснаар хүн бүр ямар системийн элементүүдийг, яг хэрхэн дүрслэх ёстойг хурдан ойлгох боломжтой болно. За, тохирох загваруудыг боловсруул.
Энэ бүхэн нь баримт бичгийн чанарыг шинэ түвшинд гаргахад туслах ёстой.
Наад зах нь тийм байх гэж найдаж байна.
Эх сурвалж: www.habr.com