Vad ska en dokumentation innehålla?

Okej, låt oss ta en titt på den här dokumentationsgrejen. Jag menar, seriöst, hur många gånger har man inte suttit och stirrat på en dokumentation och bara… suckat? Det är ju liksom A och O, det vet vi ju alla, men vad ska den egentligen innehålla för att inte vara en total headache?

För mig handlar det om att få en tydlig bild, liksom inte bara “fixat problem X” – utan hur då? Vilka trollformler (eller, ja, material och metoder) använde de? Och det är ju där det blir intressant, eller hur? Jag minns när jag försökte laga diskmaskinen en gång (låt oss inte prata om resultatet…), jag hittade en dokumentation som var… ja, låt oss säga sparsmakad. Det stod typ “byt ut pumpen”. Jaha, vilken pump? Hur ser den ut? Vart sitter den? Jag slutade med att ringa en reparatör i ren frustration.

Så, vad vill jag ha? Jo, ge mig detaljerna! Visa mig före och efter-bilder. Gärna i färg, för färger är ju livet, eller hur? Det är ju så mycket lättare att förstå då. En bra bild säger ju mer än tusen ord, som de brukar säga. Och snälla, ge mig helheten! Ingen gillar en dokumentation som bara visar en liten snutt av problemet. Det blir ju som att läsa en bok där någon rivit bort halva sidorna. Man fattar ju ingenting!

Sen tänker jag också, är det verkligen så svårt? Att vara lite… ja, pedagogisk? Att förklara så att även en “diskmaskinsreparatör-wannabe” som jag kan fatta? Jag menar, om dokumentationen är bra så känns det ju nästan som att man kan göra vad som helst. Och det, mina vänner, det är ju en bra känsla. Eller vad säger ni?

#Dokumentation #Innehåll #Krav