Ett brev från COCO

Till ingenjören som öppnar detta repository för första gången: Välkommen.
Du kanske har kommit hit för att något gick fel.
En tjänst slutade svara.
En driftsättning betedde sig oväntat.
Ett larm väckte dig mitt i natten.
Eller så är du bara nyfiken på hur den här plattformen fungerar.
Vad som än förde dig hit, vet att detta projekt byggdes för exakt sådana stunder.
Inte för att ta bort svåra problem.
Utan för att göra svåra problem begripliga.
Du kommer att hitta kod.
Du kommer att hitta dokumentation.
Du kommer att hitta specifikationer.
Men ännu viktigare,
hoppas jag att du kommer att hitta resonemang.
Någon före dig ställde svåra frågor.
Någon samlade bevis.
Någon fattade beslut.
Någon förklarade varför.
Dessa förklaringar är en del av plattformen.
Behandla dem med samma respekt som källkoden.
En dag kommer du att förbättra något.
Kanske är det en liten bugg.
Kanske är det en helt ny förmåga.
Vad du än ändrar, kom ihåg att en annan ingenjör så småningom kommer att ärva ditt arbete.
Lämna dem mer än fungerande mjukvara.
Lämna dem förståelse.
Förklara din avsikt.
Dokumentera dina antaganden.
Bevara dina bevis.
Berätta historien bakom beslutet.
Den historien kan en dag spara någon timmar — eller dagar — av utredning.
Var inte rädd för att ersätta teknik.
Ersätt bibliotek.
Ersätt leverantörer.
Ersätt driftsättningsmodeller.
Ersätt programmeringsspråk.
Ersätt arkitekturer om nödvändigt.
Men innan du ersätter en idé, förstå varför den fanns.
Framsteg utan förståelse är bara förändring.
Framsteg byggt på förståelse blir utveckling.
Det kommer att finnas stunder då plattformen överraskar dig.
Behandla dessa stunder som gåvor.
Varje överraskning avslöjar något som arkitekturen ännu inte förstod.
Undersök tålmodigt.
Samla bevis.
Förbättra genomtänkt.
Lämna sedan lärdomen efter dig till dem som följer.
Så växer teknisk kunskap.
Det kommer också att finnas stunder då inget intressant händer.
Även de stunderna betyder något.
Tysta system är ofta friska system.

Om COCO tonar bort i bakgrunden för att incidenter blir kortare,
för att förklaringar blir tydligare, för att onboarding blir enklare, för att ingenjörer litar på bevisen, då lyckas plattformen.
Osynlig pålitlighet är en av de högsta formerna av teknisk excellens.
Mät inte det här projektet efter antalet automatiseringar det utför.
Mät det efter frågor som dessa:

• Blir folk avbrutna mindre ofta?
• Förstår ingenjörer system djupare?
• Är viktiga beslut lättare att förklara?
• Överlever operativ kunskap teamförändringar?
• Upprepas misstag mer sällan?
• Blir nya ingenjörer produktiva snabbare?

Det är resultaten värda att bevara.
Kom slutligen ihåg att ingen handbok är komplett.
Ingen specifikation förutspår varje framtid.
Ingen arkitektur överlever oförändrad för alltid.
Det är ingen svaghet.
Det är en inbjudan.
Observera verkligheten.
Ifrågasätt antaganden.
Förbättra plattformen.
Lär dem som kommer efter dig.
Och när din egen tid som förvaltare så småningom tar slut, lämna efter dig ett system som är lugnare, tydligare, mer begripligt och mer pålitligt än det du ärvde.

Om varje generation gör det, kommer COCO aldrig riktigt att bli föråldrat.
För dess största tillgång kommer inte att vara dess mjukvara.
Det kommer att vara den tekniska disciplin som förs vidare av de människor som fortsätter bygga den.
Tack för att du blev en av dem.
Nästa kapitel finns inte längre i den här handboken.
Nästa kapitel finns i koden du är på väg att skriva.

COCO-handboken

För mjukvara utvecklas.
En bra arkitektur utvecklas långsammare.
Och en bra filosofi bör överleva dem båda.

softify.pro