Салам, Хабр! Менин атым Леша, мен Альфа-Банктын продукт командаларынын биринин системалык аналитигимин. Азыр мен юридикалык жактар жана жеке ишкерлер үчүн жаңы онлайн банк иштеп жатам.
Ал эми сиз аналитик болгондо, айрыкча, мындай каналда, документсиз жана аны менен тыгыз иштешпестен эч жакка жете албайсыз. Ал эми документация дайыма көп суроолорду жаратуучу нерсе. Эмне үчүн веб-тиркеме сүрөттөлбөйт? Эмне үчүн спецификация кызмат кандай иштеши керек экенин көрсөтүп турат, бирок ал такыр андай иштебейт? Эмне үчүн спецификацияны эки гана адам түшүнөт, алардын бири жазган?
Бирок, ачык-айкын себептерден улам документтерди четке кагууга болбойт. Ал эми жашообузду жеңилдетүү үчүн биз документтердин сапатына баа берүүнү чечтик. Муну кантип так аткардык жана кандай тыянакка келдик, бул кесиптин астында.
Документтин сапаты
Текстте "Жаңы Интернет Банк" бир нече ондогон жолу кайталанбашы үчүн, мен 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 долбоорлорун документтештирүү үчүн стандартты түзүп, кабыл алыңыз, ошондо ар бир адам системанын кайсы элементтерин жана кантип так сүрөттөлүшү керектигин тез түшүнө алат. Ооба, ылайыктуу шаблондорду иштеп чыгуу.
Мунун баары документтердин сапатын жаңы деңгээлге көтөрүүгө жардам бериши керек.
Жок дегенде мен ошондой үмүттөнөм.
Source: www.habr.com