Dokumentera och lämna över er lösning

En fantastisk automatisering är sårbar om bara skaparen förstår den. När ni går vidare, byter roll eller helt enkelt glömmer detaljerna blir en odokumenterad lösning en belastning.

God dokumentation och en bra överlämning gör att ert arbete består.

Dokumentationen bör börja med syftet: vilket affärsproblem löser automatiseringen och vilka förlitar sig på den?

Om ni förstår varför blir det lättare för nästa person att fatta bra beslut när något behöver ändras.

Ge en översikt på hög nivå över hur lösningen hänger ihop: vilka appar som ingår, hur data flödar och var de viktigaste arbetsflödena finns.

Ett enkelt diagram är mer värdefullt än sidor med text när man ska förstå helheten.

Dokumentera utlösaren, huvudstegen och resultatet för varje arbetsflöde. Notera alla filter, förgreningar och särskilda logik som inte är uppenbara.

Framtida underhållsansvariga ska kunna förstå vad ett arbetsflöde gör utan att behöva återskapa logiken steg för steg.

Dokumentera vilka appanslutningar lösningen använder och vilka konton som äger dem – men skriv aldrig ner själva hemliga nycklarna.

Notera vem som ska kontaktas för att förnya eller ansluta varje anslutning igen om den slutar fungera.

Den bästa dokumentationen finns inuti arbetsflödet. Använd tydliga stegnamn och plattformens anteckningsfält för att förklara svåra delar precis där de förekommer.

Beskrivande namn som Filtrera bort testbeställningar är bättre än generiska namn som Filtrera.

Skapa en driftmanual som beskriver den dagliga driften: hur ni ser om allt fungerar, vad aviseringar betyder och vad ni ska göra när något misslyckas.

Med en bra driftmanual kan någon hålla lösningen igång även utan djup kunskap om hur den byggdes.

Förutse vanliga problem och dokumentera lösningarna: vad ni ska göra om en anslutning löper ut, hur misslyckade körningar körs om och vem som ansvarar för varje externt system.

Det förvandlar ett stressigt driftstopp till en checklista som alla kan följa.

Dokumentationen är halva arbetet; en genomgång tillsammans är den andra halvan. Sitt med den nya ansvariga, demonstrera lösningen från början till slut och besvara frågor i realtid.

Om ni spelar in mötet får personen något att återvända till senare.

Dokumentation blir inaktuell när lösningen ändras men dokumentationen inte gör det. Gör uppdatering av dokumentationen till en del av varje ändring och granska den regelbundet.

Föråldrad dokumentation kan vara sämre än ingen dokumentation alls, eftersom den vilseleder.

En fullständig överlämning bekräftar att den nya ansvariga självständigt kan driva, felsöka och vidareutveckla lösningen. Följ upp efter en tid för att upptäcka eventuella luckor.

Först då är lösningen verkligen färdig från början till slut och motståndskraftig.

Ni har lärt er att dokumentera och lämna över er lösning:

• Förklara varför, och kartlägg sedan arkitekturen och varje arbetsflöde
• Lista anslutningar och ansvariga utan att avslöja hemligheter
• Använd anteckningar i arbetsflödet, en driftmanual och en felsökningsguide
• Genomför en praktisk genomgång och håll dokumentationen aktuell
• Bekräfta att den nya ansvariga självständigt kan driva och vidareutveckla lösningen

En bra överlämning förvandlar ett enpersonsprojekt till en hållbar och lättunderhållen lösning.