"Dokumentazio hilda"ren arazoa
Enpresa guztiek dakite dokumentazioa garrantzitsua dela. Baina dokumentazio gehiena zaharkituta, osatu gabe edo aurkitzeko zaila da. Taldeek wiki-ak sortzen dituzte hilabetean informazio zaharkituaren hilerriak bihurtzen direnak. Langile berriek asteak ematen dituzte moldaketa-aldian ezagutza pertsonen buruetan bizi delako, ez sistemetan. Ikuskariek prozedurei buruz galdetzen dute, eta IT sailak azkar-azkar dokumentuak biltzen ditu hainbat iturritatik.
Adimen artifizialak paradigma hau aldatzen du. Dokumentazioa ez du eskuz sortu eta eskuz mantendu beharrik — AAk kodetik sortzen du, automatikoki eguneratzen du eta bilaketa semantikoaren bidez eskuragarri jartzen du.
AAk dokumentazioa kodetik sortzen du
Adimen artifizialak iturburu-kodea aztertzen du eta automatikoki API dokumentazioa, arkitektura-diagramak, osagaien deskribapenak eta moduluen mendekotasun-mapak sortzen ditu. Hau ez da iruzkinak erauztea soilik — AAk kode-egitura ulertzen du, diseinu-patroiak identifikatzen ditu eta garatzaileentzat zein interes-talde ez teknikoentzat deskribapen irakurgarriak sortzen ditu.
CI/CDekin integratutako dokumentazioa automatikoki eguneratzen da commit bakoitzarekin. Zaharkitutako wiki-rik ez — dokumentazioa beti kodearekin koherentea da. ADR (Arkitektura Erabakien Erregistroak), C4 (arkitektura-diagramak) eta OpenAPI (API dokumentazioa) bezalako estandarrek koherentzia eta irakurgarritasuna bermatzen dute.
Ezagutza-base semantikoa
Bilaketa tradizionalak gako-hitzetan oinarritzen da — esaldi zehatza jakin behar duzu dokumentu bat aurkitzeko. Bilaketa semantikoak zure kontsultaren esanahia ulertzen du. "Nola kudeatu bezeroaren kexa bat" galdetzen duzu — sistemak prozedura aurkitzen du, nahiz eta "Salmenta Osteko Kontsulten Kudeaketa" izenburua izan eta "kexa" hitza ez eduki.
Bilaketa semantikoarekin erakundeko ezagutza-base zentralizatuak eraikitzen ditugu. Langileek segundotan aurkitzen dituzte erantzunak, ez orduetan. Taldekide berriek lehenengo egunetik dute erakundeko ezagutza osorako sarbidea.
Kalitate-proba automatizatuak
Egiaztapenik gabeko dokumentazioa azkar zaharkitzen eta fidagarritasuna galtzen du. Software-garapen prozesu guztiz automatizatu bat inplementatzen dugu proba-mota guztiekin: unitate, integrazio, E2E, UI, segurtasun, errendimendu, erregresio, smoke eta onarpen. Probek ez dute kodea soilik egiaztatzen, baita dokumentazioa ere — dokumentazioan deskribatutako API amaiera-puntuak benetan existitzen diren, parametroak bat datozen eta kode-adibideak zuzen konpilatzen diren.
Enpresako hiru dokumentazio mota
Enpresa-ingurunean, hiru dokumentazio mota nagusi bereizten ditugu:
- Software dokumentazioa — arkitektura, API, hedapena, garatzaileen harrera. AAk kodetik sortzen du eta automatikoki mantentzen du.
- IT azpiegitura dokumentazioa — sare-mapak, eragiketa-prozedurak, hondamendi-berreskuratze planak, gidaliburuak. Inbentario eta eskaneatu automatizatuak eguneratuta mantentzen dute.
- Negozio-prozesu dokumentazioa — BPMN prozesu-mapak, politikak, prozedurak, erakundeko ezagutza-basea. AAk lehendik dauden dokumentuak aztertzen ditu, hutsuneei identifikatzen die eta falta diren elementuak sortzen ditu.
Mota bakoitzak ikuspegi desberdina behar du, baina printzipio komuna bakarra da: dokumentazioak bizidun, eguneratua eta erraz eskuragarria izan behar du — edo ez du balio.