Így készüljön fel az architektúra- vagy kódfelülvizsgálatra

01Az aggályból legyen konkrét kérdés

A „Jó az architektúránk?” kérdésnél a felülvizsgáló csak találgathatja, mi fontos Önnek. Olyan kérdést tegyen fel, amelytől egy döntés megváltozhat: elbírja-e ez az integráció a következő ügyféligényt, milyen állapotban marad a rendelés, ha a fizetés meghiúsul, vagy mit kell rendbe tenni a migráció előtt? Adja meg a rendszer verzióját és a döntés határidejét.

Sorolja fel, mire nem terjed ki a felülvizsgálat. Egy célzott megbeszélés nem tudja megállapítani, hogy minden komponens biztonságos, minden hibát teszteltek, vagy az egész termék indulásra kész. Átfogóbb bizonyossághoz külön egyeztetett keret és bizonyíték kell.

02Állítson össze egy kis bizonyítékcsomagot

• Rendszertérkép: a kérdés szempontjából fontos felhasználók, szolgáltatások, adattárak és külső integrációk.
• Egy jellemző folyamat: a normál eset, a hibaeset, és az, hogy ki felel a helyreállításért.
• Korlátok: várható terhelés, válaszidő-célok, költségkeret, az adatok érzékenysége és a csapat kapacitása; a becsléseket jelölje becslésként.
• Kiválogatott bizonyítékok: a releváns kódrészletek, tesztek, érzékeny adatoktól megtisztított hibaüzenetek vagy ábrák, dátummal és verzióval.
• Döntési előzmények: milyen alternatívákat mérlegeltek, milyen feltételezésekből indultak ki, és miért a jelenlegi megoldás mellett döntöttek.

Az arc42 elválasztja a rendszert a külső felhasználóktól és a szomszédos rendszerektől, majd leírja a köztük lévő interfészeket. Ez a felépítés egy felülvizsgálati ábrához is jól használható, akkor is, ha a teljes dokumentációs sablont nem alkalmazza. arc42: kontextus és hatókör.

Kódfelülvizsgálatnál azt a módosítást vagy kódrészt válassza ki, amely a kérdéshez kapcsolódik. A Google felülvizsgálati útmutatója a stíluson túl a tervezést, a szándékolt működést, a fölösleges bonyolultságot és a teszteket is nézi. Adjon annyi környezetet, hogy ezeket a szempontokat is meg lehessen ítélni. Google: mire figyeljünk kódfelülvizsgálatkor.

Az is hasznos információ, ha valamit nem tudnak. Ha senki sem tudja, mekkora a jelenlegi csúcsterhelés, vagy hogy egy mentés visszaállítható-e, mondja ki. A felülvizsgáló így meg tudja különböztetni a hiányzó mérést a bizonyított rendszerhibától; ha a hiányt csendben egy magabiztos becsléssel pótolja, ez nehezebb lesz.

03Megosztás előtt egyeztesse a hozzáférést és az előzetes átolvasást

A megkeresést bizalmas adatok nélküli leírással kezdje. Jelszót, tokent, ügyféladatot vagy privát repository tartalmát ne másolja nyilvános kapcsolatfelvételi űrlapba. Ha a megbízáshoz privát anyagokra van szükség, előbb egyeztessék a keretet, a hozzáférés módját és a felhasználás feltételeit. Lehetőleg a legkisebb releváns, érzékeny adatoktól megtisztított bizonyítékkészletet ossza meg, és ahol lehet, csak olvasási hozzáférést adjon.

Kérdezze meg, mennyi anyagot lehet reálisan átolvasni a megbízás keretében. Ha közvetlenül a konzultáció előtt elküld egy nagy repositoryt, abból még nem lesz megállapodás egy teljes auditról. Az előzetes átolvasást, a hozzáférés beállítását és az írásos anyagot kifejezetten erősítsék meg; ne feltételezze, hogy ezek benne vannak, csak mert van egy egyeztetett megbeszélés.

04A megállapítások legyenek használhatók a csapatnak

Kérje meg a felülvizsgálót, hogy válassza külön a megfigyelt tényeket, a valószínű magyarázatokat és a megválaszolatlan kérdéseket. Minden lényeges problémánál a csapatnak értenie kell, melyik működést érinti, mi támasztja alá, és mi a következő lépés. A prioritást az üzleti következmény és a megállapítás megbízhatósága határozza meg, nem az, hogy mennyire divatos a helyette javasolt technológia.

• Erősítse meg, melyik rendszerverzióra és bizonyítékra vonatkozik a megállapítás.
• Nevezze meg, ki vizsgálja ki, fogadja el vagy oldja meg.
• Határozza meg, hogyan ellenőrzi a csapat, hogy a módosítás valóban megoldotta a problémát.
• Az átadáskor maradjon látható, mely területeket nem vizsgálták át, és mi maradt bizonytalan.

A Robles Consulting Architektúra- és kódfelülvizsgálata egy célzott, 120 perces konzultáció. A nagyobb, egyeztetett bizonyítékokra épülő, írásos anyaggal záruló értékelés az Architektúra-audit. Időpontkérés előtt az ajánlat részletei alapján válassza ki a megfelelő keretet.