Карталар, алтын жана жыпар жыттуу заттар: Эмне үчүн документацияга көңүл бурбоо сиздин долбооруңузду кыйроого учуратышы мүмкүн

Байыркы изилдөөчүлөр саякаттарынан үйгө алып келген эң баалуу байлык эмне болгон? Алтын жана татымал? туура эмес. Карталар.

Христофор Колумб 1492-жылы атактуу саякатка чыкмак эмес карта анын мурункулары тарабынан иштелип чыккан. Португал карталарын алуу үчүн шпион оюну адамзат тарыхындагы эң кымбат компания болгон Голландиялык Ост-Индия компаниясынын пайдубалын түптөгөн. 1637-жылы эң жогорку чегинде ал 78 миллион голландиялык гулденге барабар болгон. 7,9 триллион доллар 2017-жылы доллар. Бул 2024-жылы 10 триллион доллардан ашык, бул Microsoft , Nvidia жана Apple компанияларынан көп. бириктирилген . Кыска мөөнөттө жаңы жерлерден табылган байлыктар маанилүү болгон, бирок узак мөөнөттүү көз караштан алганда, чыныгы байлыктарды жараткан билим болгон.

Эмне үчүн бүгүнкү технология дүйнөсүндө биз муну унутуп калабыз? Дароо ийгиликке жетүү үчүн биз көп учурда техникалык документтерди даярдоого жана сактоого баалуу убакытты жана ресурстарды бөлүүнү каалабайбыз. 17-кылымдын терминдеринде айтсак, биз карталарыбызды түзбөстөн, алтын менен татымалдарды алууга шашылабыз, бул болсо, өз кезегинде, бизди алда канча көп алтын жана татымалдарга алып келиши мүмкүн. Сиз скептиксизби? Ой, жакшыраак карап көрөлү ...

Акылсыз код

"Сиздин эсиңизде болсо керек, мээнин нейрондук түзүлүштөрүнүн гипноиддик стазасын экстра-электромагниттик нур аркылуу сканерлесе болот, ал -" "Кеткиле!" — деди чыдамсыздык менен Ард Варк. "Сиз эмнени айтып жатасыз - биз эч кандай шек жок эсибизде?" Биз аны эч качан билбегенибиз менен кантип эстей алабыз? – Улуу илимий фантаст Эдмонд Гамильтондун «Wacky World» китебинен алынган бул цитата программисттерге эмес, марстыктарга тиешелүү. Бирок, көптөгөн адамдар иштеп чыгуучуларды башка планетадан келгендей көрүшөт, айрыкча программалык камсыздоону иштеп чыгуу жана анын татаалдыктары жөнүндө бүдөмүк түшүнүккө ээ болгондор. Чындыгында, иштеп чыгуучулар көбүнчө кодду башкалардай эле билет деп ойлошот жана көп учурда техникалык документтерди керексиз деп эсептешет. Мындай ой жүгүртүү долбоорду "гипноиддик стаз" сыяктуу татаал жана бөтөн адамдар үчүн түшүнүксүз кылып, акыры долбоордун потенциалдуу ийгилигине шек келтирет.

Документтерди түзүүнү каалабагандыгы көбүнчө ошол эле себептерден келип чыгат, адамдар башка аймактарда создуктурат: бул олуттуу убакытты жана финансылык инвестицияларды талап кылат. Башкача айтканда, бул көбүнчө жалкоолуктан жана акчаны үнөмдөө каалоосунан улам болот, аларды жеңүү оңой эмес. Бирок, документация ар бир адам үчүн ачык делген ашыкча маалымат эмес; ал зарыл болгон маанилүү деталдарды камтыйт. Көп учурда документтердин жоктугу каталарды аныктоону жана оңдоону бир топ кыйындатат, техникалык тейлөөнү жана жаңыртууларды кыйындатат жана команданын жаңы мүчөлөрүн ишке киргизүү үчүн талап кылынган убакытты көбөйтөт. Документи жок командалар кайталанма тапшырмаларды аткарууда тыгылып калганы менен, жакшы структураланган документтери бар долбоорлор жогорку натыйжалуулукту жана ишенимдүүлүктү көрсөтөт — бул жөн эле пикир эмес, факт.

Ооба, кээ бир программисттер алар жазган код ушунчалык ачык-айкын жана түшүнүктүү болгондуктан, документтердин кереги жок деп ырасташат. Бирок, чындыгында, эң кемчиликсиз код дагы башкаларды чаташтырышы мүмкүн же убакыттын өтүшү менен анын ачыктыгын жоготуп коюшу мүмкүн. Бүгүн ачык көрүнгөн нерсе эртең баш катырма болуп калышы мүмкүн. Мисалы, 70-жылдардагы жөнөкөй перфокарта менен оңой күрөшө аласызбы?

Автобус фактору, Burnout жана башка фантастикалык жырткычтар

Теория жакшы, бирок практика ынандырарлык. Бул жерде адамдардын жана компаниялардын аттары гана ойдон чыгарылган чыныгы окуяларга негизделген кээ бир мисалдар келтирилген. Бул кыскача мисалдар техникалык документтердин начар практикасынан улам келип чыккан эң типтүү көйгөйлөрдү камтыйт.

Окуя №1: Өлчөмдү көтөрө албоо

"NoDocumentationPlease" долбоору алгач ийгиликтүү видео агымын баштоо, начар техникалык документтерден улам масштабга аракет кылып жатканда олуттуу көйгөйлөргө туш болду. Команданы кеңейтүү керек болгондо, жаңы кызматкерлер өз милдеттерин толук түшүнө алышкан эмес жана аларга эч ким адекваттуу түшүндүрмө бере алган эмес. Тийиштүү колдоо жана окутуу болбосо, жаңы жумушка орношкондор тез эле кетип калышты. Бул долбоордун жүрүшүн басаңдатып гана тим болбостон, негизги таланттарды жоготууга алып келип, акыры долбоордун жалпы натыйжалуулугуна жана келечегине коркунуч келтирди. Натыйжада стримерлер чаттан чыгып, долбоор жабылган.

Окуя №2: Техникалык тейлөө маселелери

"IKnowEverything" компаниясы маалыматтарды синхрондоштуруу жана сактоо үчүн булут платформасын иштеп чыккан. Башында долбоор тез эле алдыга жылды, бирок убакыттын өтүшү менен аны иштеп чыгуучулар так жана актуалдуу техникалык документтердин жоктугунан платформаны сактоо жана жаңыртуу кыйынчылыкка туш болушту. Бул жайыраак өнүгүүгө, көп мүчүлүштүктөргө жана кардарлардын нааразы болушуна алып келди. Акыр-аягы, компания өзүнүн эски кардарларын жогото баштады, ал эми жаңы кардарлар кыйла туруктуу жана ишенимдүү чечимдер менен атаандаштарды тандап алды. Натыйжасыз тейлөөгө кеткен чыгым өскөндө кирешелер бир топ азайды. Техникалык аспектилерди башынан эле туура документтештирүү, аларды ийгиликтүү масштабга чыгарууга мүмкүндүк бере алмак. Бирок, ал өз убагында аткарылган эмес. Натыйжада, компания техникалык жана каржылык кыйынчылыктарды жеңе албай, жабылган.

Окуя №3: Developer Burnout

"SmartestEver" долбоору оор маселелерге туш болду, анткени анын негизги иштеп чыгуучусу, дээрлик бардык нерсени чечкен Эндрю команданын көптөгөн суроолоруна кабылып, кызматтан кеткен. Эгер "SmartestEver" тийиштүү документтери болгондо, кенже иштеп чыгуучулар көп берилүүчү суроолорго оңой кайрылышып, күнүмдүк маселелерди чечишмек. Анын ордуна, алар Эндрю суроолору менен бомбалашты, ансыз жана керектүү документтерсиз, команда жөн эле бара албай, долбоор жабылды (Эндрю үчүн F баскычын басыңыз).

Окуя №4: Автобус фактору

"NoDocsNeeded" компаниясында бардык билимге ээ болгон, бирок аны документтештирүүгө убара болбогон негизги иштеп чыгуучу Джон тарабынан келечектүү программалык продукт иштелип чыккан. Жетекчилери да аны көндүрүүгө убара болгон жок. Бир күнү Жон командировкага кетип, кайра келбей калды. Документсиз же буюмдун архитектурасын жана логикасын түшүнбөсө, команданын калган мүчөлөрү эч нерсе кыла алышпайт. Долбоор тоңдурулуп, ага салынган акча ысырап болгон. Сабак жөнөкөй: бир адамдан көз каранды болбоо үчүн документтештирүү жана билимди команда ичинде бөлүштүрүү абдан маанилүү. Айтмакчы, алар дагы эле Жонду издеп жатышат...

Окуя №5: Ачык булакта эч бир пайгамбар кабыл алынбайт

Мария өзүнүн биринчи ачык булак китепканасын түзгөн, бирок ал үчүн эч кандай документ жазган эмес. Китепкана эмне кылып жатканын эч ким түшүнгөн жок жана Мария мындан ары китепкана жазбайм деп чечти, анткени ага бул маанисиз көрүнгөн. Мариянын долбоору баштала электе бүтүп, кесибин өзгөртүүнү чечкен.

Кабинанын баласынан капитанга чейин

Макул, бизде теория жана практика бар, эми изилдөөгө жана статистикага кайрылалы. Stack Overflow Developer Survey 2024 мамлекеттер Респонденттердин 84% технологиялардын функционалдуулугун түшүнүү үчүн техникалык документтерди колдонушат. Бирок, документация менен болсо да, алар керектүү жоопторду таба алышпайт, муну кийинки эң популярдуу ресурстар: Stack Overflow (80%), Жазылган окуу куралдары (68%), блогдор (61%) жана Кантип жасоо керек? видеолор (54%). Microsoft Research: Программалык камсыздоону иштеп чыгуучулардын күнүмдүк жашоосу табылган орто эсеп менен иштеп чыгуучулар күнүнүн 1-2%ын (8-10 мүнөт) документтештирүүгө жумшашат, ал эми иштеп чыгуучулардын 10,3% эскирген документтер аларды өз алдынча жооп издөөгө өтө көп убакыт коротууга мажбурлайт дешет. Документтердин зарылчылыгы академиялык коомчулук үчүн да негизги маселе. <"documentation" ЖАНА "программалык камсыздоо"> үчүн жөнөкөй Google Scholar издөө түшүм берет 4 миллиондон ашык натыйжалар, бул маселени караган илимий басылмалардын көп санын ачык көрсөтүп турат.

Негизги корутундулар укмуштуудай жөнөкөй: №1 – Технологияны жана/же башка адамдардын ишин түшүнүүгө келгенде ар бир адам документацияга муктаж; бирок №2 – Аз эле адамдар жазып жана аны сактап убара; жана натыйжада №3 – Көптөгөн документтер начар жазылган, эскирген жана жалпысынан пайдасыз. Анда эмне кылуу керек? Мотивацияңызды бардык деңгээлде өзгөртүңүз.

HAN Колдонмо илимдер университетинин жана Гронинген университетинин изилдөөчүлөрүнүн тобу (экөө тең Нидерландыда) аныкталган техникалык документациянын эң типтүү көйгөйлөрү:

• Иштеп чыгуучулар көп колдонгон расмий эмес документтерди түшүнүү кыйын;

• Документтер акыркы продуктка дароо салым кошпогондо калдык деп эсептелет;

• Иштеп чыгуучунун өндүрүмдүүлүгү иштеген программалык камсыздоонун көлөмү менен гана өлчөнөт;

• Документация көбүнчө программалык камсыздоо менен шайкеш келбейт;

• Иштеп чыгуучулар көбүнчө кыска мөөнөттүү фокустарды, айрыкча үзгүлтүксүз программалык камсыздоону иштеп чыгуу чөйрөсүндө кармашат.

  
  

Мунун бирөө тааныш угулат беле? Күндөлүк ишибизде көбүбүзгө бир эле учурда алардын көбүнө же атүгүл бардыгына туш болгонбуз деп ишенем. Ал эми бул жөн эле создуктуруп же ресурстардын жетишсиздигинен башка дагы бар. Бул көйгөйлөрдүн айрымдары туура башкаруунун, узак мөөнөттүү пландаштыруунун жана, акырында, стратегиялык көз караштын жоктугунан келип чыгат. Ал эми бул жерде кыйын бөлүк келет, анткени бул бизден, иштеп чыгуучулардан гана эмес. Кээ бир маселелер менеджерлер, продукт кызыкдар тараптар, ал тургай, компаниянын ээлери тарабынан чечилиши керек. Ошондуктан, техникалык жактан туура көз караштар жөн гана жакшы аксессуар эмес, негиздөөчүлөрдөн баштап кенже иштеп чыгуучуларга чейин жалпы компаниянын негизги баалуулуктарынын бир бөлүгү болушу абдан маанилүү.