← Alla kundcase
Kundcase · Detaljhandel

Dokumentationen blev en granskning på cirka tio minuter i veckan

Så flyttade kunskapen från huvuden till repot i en plattform med runt 950 dbt-modeller.

I en dataplattform med runt 950 dbt-modeller och ett tiotal utvecklare i samma repo hinner dokumentationen bli gammal mellan två sprintar. Rebtech byggde en agent som varje söndag jämför dokumentationen mot koden och skapar ett förslag på en färdig ändring att granska, i stället för att var och en ska underhålla sin egen dokumentation.

Om uppdraget

Kund
Internationellt detaljhandelsföretag, avidentifierat
Bransch
Detaljhandel
Uppdrag
AI-driven automatisering inom dataplattformsförvaltning
Omfattning
Cirka 950 dbt-modeller, 360 test- och schemafiler, ett tiotal utvecklare i samma repo
Roller
Senior data engineer med AI-inriktning
Teknikstack
BigQuery, dbt, git-baserat repo
Leverans
Agent för löpande dokumentationsunderhåll, i drift veckovis
Metod
RAID
Utmaningen

Inaktuell dokumentation är farligare än ingen alls

Problemet är sällan att dokumentationen saknas. Den skrevs en gång, av någon som förstod vad den beskrev, och var korrekt den dagen. Sedan flyttades en modell, ett kommando byttes ut, en tabell fick ny betydelse, och ingenting av det syntes i dokumentet. Ingen gjorde fel, det finns bara ingen punkt i ett normalt arbetsflöde där någon ansvarar för att kontrollera vad som slutat gälla.

Det gör inaktuell dokumentation farligare än ingen alls. Den som litar på den fattar beslut på fel underlag, den som inte litar på den läser koden i stället. Tydligast syns det vid överlämning: när det skrivna inte stämmer stannar kunskapen kvar hos den som byggde plattformen, och personberoendet växer.

Lösningen

Ett medvetet smalt mandat: dokumentation, aldrig kod

Agenten underhåller tre ytor: lösningsdokumentationen, den gemensamma affärsordlistan och de verifierade fakta som skrivits ned per affärsområde. För varje dokument prövar den om det som refereras fortfarande finns, om lösningen motsvarar koden, om kommandona matchar hur teamet arbetar och om ett nyare dokument gjort det gamla överflödigt. Sedan landar den i ett av sex utfall, var och ett belagt mot något den läst i repot:

  • Behåll
  • Uppdatera
  • Slå ihop
  • Ersätt
  • Ta bort
  • Märk som osäkert

Den viktigaste regeln är att den inte får gissa. Kan den inte belägga vad som gäller idag ska den märka dokumentet som osäkert, med orsak och datum, och lämna innehållet i fred. En språkmodell utan underlag skriver något rimligt, välformulerat och felaktigt, och det är den farligaste utdatan eftersom den är omöjlig att skilja från den korrekta vid granskning.

Resultat

Kunskapen flyttar löpande från huvuden till repot

Att få en agent att skriva dokumentation går snabbt, att få den att låta bli är svårt, och det är där värdet ligger. Utvecklingsteamet lägger inte längre tid på dokumentationsunderhåll utan på en granskning som tar minuter, kunskapen flyttar löpande från huvuden till repot och en ny utvecklare introduceras mot dokumentation som stämmer med koden.

Det är skillnaden mellan dokumentation som teamet använder och något teamet slutar öppna.

I korthet
  1. 01

    Dokumentationsunderhållet är en veckovis granskning i stället för ett projekt

  2. 02

    Sex definierade utfall, vart och ett belagt mot något agenten läst i repot

  3. 03

    Dokument som inte går att belägga märks som osäkra, med orsak och datum

Står ni inför en liknande utmaning?

Har er dokumentation slutat stämma?