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!

Dela på facebook
Dela på twitter
Dela på linkedin
Dela på email

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

Fler inlägg

Buffe med mat

Därför ska du skriva manualen som en buffé

Jag är en förespråkare av modulär teknisk dokumentation. Varför? För att det gör dokumentationen lättare att använda, lättare att skriva och framför allt lättare att uppdatera. Hur då? Modulärt julbord

Instruktioner för att laga soppa

User stories ger dig rätt instruktioner (del 2)

User stories visar vad er produkt faktiskt ska uträtta åt användaren. Eller snarare vad användaren vill göra. Du kan nu enkelt förstå vilka instruktioner som du behöver skriva. Välkommen till

Läsare av teknisk dokumentation

Fixa dokumentationen med user stories (del 1)

User stories kan ge dig en flygande start när du ska skriva teknisk dokumentation, särskilt manualer av olika slag. Det gäller oavsett om det är grundläggande manualer till slutanvändare, integrationsinstruktioner

Musfälla

Trick för att locka information ur utvecklare

Att få fram underlag till teknisk dokumentation är verkligen en utmaning. Själv har jag provat allt. Jag har mutat utvecklare med kakor. Intervjuat stressade projektledare. Filtrerat ofantliga mängder med utvecklingsärenden

Tips till dig som skriver lathund i affekt

Behöver dina kunder en lathund för er produkt? Eller behöver ni själva en intern lathund på kontoret för att komma tillrätta med reseräkningarna? Lathundar kan vara många olika saker. Allt

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.