Skapa effektiv dokumentation istället för en papperstiger

Dokumentation Regulatoriska krav

Inom IT-branschen gäller oftast snabba puckar och det agila arbetssättet uppmuntrar kommunikation framför dokumentation. Min erfarenhet är att många är rädda för att dokumentationen ska bli tungrodd och göra att produktiviteten minskar. Men det behöver inte bli så om du gör det på ett smart sätt. 

Större krav på dokumentation

Det kommer allt fler regulatoriska krav även på mjukvara och då gäller principen att ”det som inte finns dokumenterat har inte hänt”. GDPR rörde definitivt om i grytan. Nu är även informationssäkerhet i ropet, vilket du i upphandlingar kan märka genom krav på följsamhet mot den s.k. 27000-serien. Ibland ser du dessutom krav på kvalitetsledningssystem som följer ISO 9001, eller till och med ISO 14001 för den mer miljömedvetne.

Som om inte det var nog: sedan 2010 räknas journalsystem och andra system inom vården som medicintekniska produkter och måste CE-märkas. Därmed ställs krav på kvalitetsledningssystem enligt ISO 13485, riskhantering enligt ISO 14971 och en utvecklingsprocess enligt IEC 62304. Bland annat.

Det är ett faktum att inte ens IT-branschen slipper undan dokumentationskraven längre. Vad får det här för konsekvenser för din verksamhet? Måste all kreativitet i utvecklingsteamet kväsas av pappertigrar?

Täppa till små glapp

Nä, det är dags att sluta sätta likhetstecken mellan en väldokumenterad utvecklingsprocess och tjocka luntor med A4-blad. Faktum är att du förmodligen redan har stora delen av processen dokumenterad!

Kanske arbetar du redan med user stories, har utvecklingsärenden i JIRA och checkar in din kod i ett versionshanteringssystem? Då har du redan stora bitar av spårbarheten på plats. Och har du till och med nedskrivna testfall och versionshanterade testprotokoll? Toppen!

Oftast handlar det om att identifiera små glapp i processen, som relativt enkelt kan täppas till. Ibland kan det handla om att ni redan rapporterar in de buggar ni hittar när ni testar, men glömmer att dokumentera vad ni har testat och som funkade bra. Eller lagrar ni dokumentationen på en vanlig filserver där ni inte har automatisk versionshantering? Det brukar gå snabbt att lösa på ett IT-bolag, genom att införa Confluence, Sharepoint eller något annat system som håller koll på versionerna åt dig.

Tre tips för effektiv dokumentation

När du ska komplettera utvecklingsprocessen med ytterligare dokumentation så har jag tips på tre frågor du bör ställa dig:

  1. Gör din komplettering att processen nu går att följa både framlänges och baklänges?
    Du kan föreställa dig att dokumentationen är ett recept på produkten. Skulle produkten gå att (hyfsat) återskapa utifrån dokumentationen?
  2. Har du skrivit texten på ett sätt så att även en extern person skulle kunna följa processen, utan att för den skull bli övertydlig?
    Föreställ dig en revision. Skulle personen som utför revisionen kunna hänga med, utan att behöva veta en massa om era system och arbetssätt?
  3. Bidrar dokumentationen med värde till er verksamhet?
    Kan det till exempel vara värdefullt att om ett år kunna gå tillbaka och se varför ni valde att inte göra på det mest intuitiva sättet utan istället ta den lilla omvägen? Kan dokumentationen göra det lättare för nyanställda? Kan den bidra till mindre personberoende, så att ni minskar flaskhalsar och därmed får ett bättre flöde?

Behöver du hjälp att identifiera var era glapp och flaskhalsar finns?

Kontakta mig på info@gunillasvanfeldt.se om du vill veta mer!

Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.

Fler inlägg

förädla din braindump

Förädla din braindump

Braindumps kan vara en guldgruva Nu kanske du som känner mig börjar undra om jag har slagit hårt i huvudet? I alla fall du som hört mig beklaga mig över

Gör dina tabeller lättlästa

Tabellen är teknikinformatörens bästa vän. Men bara om du gör den lättläst. Ett vanligt problem är att tabellen inte innehåller någon luft alls. Kanske i ett försök att spara plats?

Zooma lagom mycket

Lilla skärmdumpsskolan del 5: Anpassa storleken

Ibland visar du bara en liten detalj i bilden, ibland behöver du visa hela fönstret. Men hur stor och inzoomad bör bilden egentligen vara? Följ tips nummer fem i lilla skärmdumpsskolan

Undvik stötande innehåll

Lilla skärmdumpsskolan del 2: Visa rätt data

Ofta behöver vi som skriver manualer ta skärmdumparna i någon slags test- eller QA-miljö för att hinna få manualen klar innan mjukvaran går i produktion. Och vi har nog alla

Gunilla Svanfeldt Omslag

Samtycke till marknadsföring

Vi lagrar informationen som du anger i formuläret för att kunna kontakta dig med nyhetsbrev, om uppdateringar och med erbjudanden. 

Markera kryssrutan i formuläret för att ge ditt samtycke till att vi skickar e-post till dig.

We use MailerLite as our marketing automation platform. By clicking below to submit this form, you acknowledge that the information you provide will be transferred to MailerLite for processing in accordance with their Privacy Policy and Terms of Service.