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 braindumps och hur de ställer till det i dokumentationen.
Varför? Låt mig ge ett exempel.

Scenario (based on a true story)

Den ledande utvecklaren säger upp sig och ägnar sin sista vecka åt att skriva ner allt hen tycker är viktigt om systemet. Hen gör sitt bästa för att få med allt som efterträdaren kan behöva veta – men tiden är knapp, och ingen hinner gå igenom eller ifrågasätta innehållet.

Resultatet? En mix av systemarkitekturbeskrivningar, kravspecifikationer, bakgrundshistorier, riskbedömningar och personliga åsikter om tekniska lösningar som ”borde” bytas ut. En braindump.

Vad är problemet med braindumps?

Braindumps är subjektiva ögonblicksbilder, inte en systematisk dokumentation.

Eftersom ingen har kvalitetssäkrat eller strukturerat innehållet, blir de omöjliga att underhålla och uppdatera. Den löpande texten är ofta vag och generaliserande, och systemskisserna – med sina otaliga pilar – bidrar inte till att göra det mer överskådligt.

Dessutom passar dessa dokument sällan in i dokumentstrukturen.

De är varken tydliga dokumenttyper eller kopplade till en viss produkt eller projekt, utan blir istället ”dokument-snöflingor” – unika, men omöjliga att kategorisera och underhålla. De lämnas ofta orörda medan utvecklingen går vidare.

Men är braindumps värdelösa? Absolut inte!

Rätt använt kan en braindump vara en guldgruva för en teknisk skribent. Men det kräver en arbetsinsats.

Du måste kavla upp ärmarna, plocka fram ”guldpannan” och börja vaska fram guldet. När du väl hittat guldkornen, kan du förädla dem till värdefull information – tydligt strukturerad och anpassad till målgruppen.

Först då blir informationen möjlig att

• hitta
• använda
• uppdatera

Ja, värdefull, helt enkelt.

Vad är din syn på braindumps? Har du stött på dem? Hur hanterar du dem?
Kanske till och med gjort dig skyldig till en? 😱