Ako udržať model aktuálny

Obvyklé vysvetlenie je disciplína a je nesprávne. Tí istí inžinieri, ktorí nechajú model dva roky zastarávať, majú testovaciu sadu každý deň zelenú, a rozdiel nie je v tom, ako veľmi im na tom záleží - je v tom, že padnutý test zastaví pipeline a nesprávny diagram nezastaví nič.

Kód je obklopený mašinériou, ktorá naň v okamihu zmeny upúta pozornosť: kompilátor, beh testov, recenzent, ktorý ho musí schváliť. Model na wiki nemá nič z toho. Nič na ceste od tiketu do produkcie nikoho nenúti otvoriť tú stránku, takže nič nikdy nevynesie nesúlad na povrch. Model sa nezhoršuje - systém sa pohne a model zostane presne tam, kde bol.

Každé usporiadanie, ktoré funguje, má rovnaký tvar: model je umiestnený tam, kde doňho narazí existujúci krok.

Dajte pohľad do repozitára. Diagram commitnutý ako Mermaid vedľa kódu sa objaví v diffe, keď sa jeho súbor zmení, a prečíta ho ten, kto zmenu reviduje. Je to jediný mechanizmus na tomto zozname, ktorého udržiavanie nestojí nič, pretože revízia sa už aj tak diala.

Odkazujte na pohľady zo záznamov rozhodnutí. Krátky záznam architektonického rozhodnutia, ktorý odkazuje na pohľad zobrazujúci štruktúru, o ktorej rozhodol, znamená, že sa pohľad otvorí vždy, keď sa niekto spýta, prečo je štruktúra taká - a to je presne vtedy, keď by na jeho nesprávnosti záležalo.

Urobte z modelu zdroj niečoho, čo ľudia potrebujú. Ak pohľad na nasadenie generuje diagram v runbooku alebo doménový model generuje glosár, v ktorom hľadá podpora, potom si toho niekto všimne v priebehu dní a nie štvrťrokov.

Druhou polovicou odpovede je, že väčšina modelov je príliš veľká na udržiavanie, a to nespraví žiadny proces. Ak by údržba modelu zabrala deň mesačne a tím má hodinu, model zastará bez ohľadu na to, ako je revízia usporiadaná - takže poctivý krok je orezať ho na tú hodinu.

Je to tá istá skúška ako pri vymedzovaní rozsahu, len uplatnená neskôr: pohľady, ktoré nedokážu pomenovať rozhodnutie, sú tie na zahodenie, a ich zahodenie nie je strata, pretože sa aj tak nečítali. Čo zostane, je dosť malé na to, aby si niekto všimol, keď je to nesprávne.

Potom zvyšok naozaj zmažte. Toto je krok, ktorý ľudia neurobia, a zároveň ten s najjasnejšou aritmetikou. Chýbajúci diagram stojí čitateľa desať minút vypytovania sa; sebavedomo nesprávny diagram ho stojí deň a pri troche smoly aj rozhodnutie postavené naň. Dokumentácia, ktorú nebudete udržiavať, nie je neutrálna, je to pasca s logom vášho tímu.