Dokumentationen som kompost

Så här mitt i kallaste januari är det hög tid att beställa de fröer som behöver börja förodlas nu. Med frölådan i ena handen och planen för växtföljden i den andra slog det mig: teknisk dokumentation är som komposten i en trädgård.

Hur tänker jag nu?

Många hanterar komposten (och dokumentationen) som en oundviklig restprodukt. De upprättar motvilligt en hög för ogräs, löv och gamla grenar i ett undanskymt hörn av trädgården.

Den som har läst på och kommit lite längre i sitt odlande vet att kompostjord utgör en fantastisk källa till växtnäring och ger mylla med fin struktur. Kompostjorden håller fukt och ger bra odlingsbetingelser i längden. Den där torvmullen du köper på påse står sig slätt i jämförelse.

Compost-driven gardening

När du har börjat inse detta kommer din syn på komposten att skifta. Istället för att sucka över ogräsrensningen kommer du att börja leta efter material att lägga på din kompost. Lagom med grönt kväverikt bladverk och lagom med brunt, kolrikt material. För nu har du börjat lära sig hur du får till den bästa kompostjorden, och på effektivaste sättet. Kanske börjar du även experimentera med varmkost, maskkompost och bokashi?

I din tekniska dokumentation kikar du i det här läget på möjligheterna med information mapping, DITA eller single-sourcing.

Växla upp och utnyttja fördelarna

Snart börjar du experimentera med hur du kan få upp värmen i komposten. Kanske odlar du squash ovanpå och drar nytta av temperaturökningen och den direkta kväveinjektionen. Det medför vare sig extra kostnad, miljöbelastning eller särskilt mycket extra tid.

På samma sätt kan du med rätt slags dokumentation få en skjuts framåt i din verksamhet. Du kan undanröja frustration, friktion och flaskhalsar. Du kan utnyttja och omvandla befintlig kunskap och möta informationsbehovet där det finns.

Eliminera redundanta mellansteg

Den riktigt initierade odlaren förstår att minska alla onödiga mellansteg och kör direktkompostering. Det innebär att du lägger ogräsrenset direkt mellan raderna i grönsakslandet eller runt fötterna på hallonen. Den täckodlingen minskar mängden ogräs, ger direkt näring till växterna och eliminerar allt redundant arbete. Du slipper ju först lägga materialet på komposten för att senare gräva bort det och sprida ut det igen.

Ett processnära sätt att dokumentera är att använda JIRA eller liknande ärendehanteringssystem. Här kan du hantera mycket information som en del av ett flöde och utan att behöva dubbeldokumentera. Du kan följa status på en händelse, dokumentera lösningen på ett problem och ärendena kan fungera som input till en backlog. Du tappar inget på vägen, alla ”näringsämnen” finns kvar.

Ibland är det värt lite extra jobb

En nackdel med både ärendehanteringssystem och direktkompostering är kanske presentationssättet. Precis som det kanske inte är så tilltalande med ogräsrens runt paradrosorna på tomtens framsida, så finns det snyggare och effektivare sätt att presentera information på än i JIRA. Ibland vill du skriva om och sammanställa för en annan målgrupp än det ursprungligen skrevs för. Då kan andra verktyg och metoder passa bättre.

Skapa en fin mylla!

Min slutsats är att det är dags att sluta se teknisk dokumentation som något trist ”måste”. Utforska istället möjligheterna som kan göra att du får en vitamininjektion i dina projekt, din produkt eller din verksamhet i stort!

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.