Jak udržet model aktuální

Obvyklé vysvětlení je disciplína a je nesprávné. Titíž inženýři, kteří nechají model dva roky zastarávat, mají testovací sadu každý den zelenou, a rozdíl není v tom, jak moc jim na tom záleží - je v tom, že spadlý test zastaví pipeline a špatný diagram nezastaví nic.

Kód je obklopen mašinerií, která na něj v okamžiku změny upoutá pozornost: kompilátor, běh testů, recenzent, který ho musí schválit. Model na wiki nemá nic z toho. Nic na cestě od tiketu do produkce nikoho nenutí tu stránku otevřít, takže nic nikdy nevynese nesoulad na povrch. Model se nezhoršuje - systém se pohne a model zůstane přesně tam, kde byl.

Každé uspořádání, které funguje, má stejný tvar: model je umístěn tam, kde do něj narazí existující krok.

Dejte pohled do repozitáře. Diagram commitnutý jako Mermaid vedle kódu se objeví v diffu, když se jeho soubor změní, a přečte ho ten, kdo změnu reviduje. Je to jediný mechanismus na tomto seznamu, jehož udržování nestojí nic, protože revize se už stejně děla.

Odkazujte na pohledy ze záznamů rozhodnutí. Krátký záznam architektonického rozhodnutí, který odkazuje na pohled zobrazující strukturu, o níž rozhodl, znamená, že se pohled otevře pokaždé, když se někdo zeptá, proč je struktura taková - a to je přesně tehdy, kdy by na jeho nesprávnosti záleželo.

Udělejte z modelu zdroj něčeho, co lidé potřebují. Pokud pohled na nasazení generuje diagram v runbooku nebo doménový model generuje glosář, ve kterém hledá podpora, pak si toho někdo všimne během dnů a ne čtvrtletí.

Druhou polovinou odpovědi je, že většina modelů je příliš velká na udržování, a to nespraví žádný proces. Kdyby údržba modelu zabrala den měsíčně a tým má hodinu, model zastará bez ohledu na to, jak je revize uspořádána - takže poctivý krok je oříznout ho na tu hodinu.

Je to stejná zkouška jako při vymezování rozsahu, jen uplatněná později: pohledy, které nedokážou pojmenovat rozhodnutí, jsou ty k zahození, a jejich zahození není ztráta, protože se stejně nečetly. Co zbude, je dost malé na to, aby si někdo všiml, když je to špatně.

Pak zbytek opravdu smažte. Tohle je krok, který lidé neudělají, a zároveň ten s nejjasnější aritmetikou. Chybějící diagram stojí čtenáře deset minut vyptávání; sebevědomě nesprávný diagram ho stojí den a při troše smůly i rozhodnutí na něm postavené. Dokumentace, kterou nebudete udržovat, není neutrální, je to past s logem vašeho týmu.