Hoppa till innehållet
EngineerRådgivning
Meny
Design
Svenska

Engineer / Rådgivning / Portfölj

Skrev 50 000 ord programvarudokumentation

Skrev 50 000 ord utförlig programvarudokumentation i Markdown på GitHub, Craft och Confluence och säkerställde därmed att kunskapen bevarades och att processen var transparent.

Situation. Det mesta som var viktigt om produkten och om hur teamet arbetade fanns i folks huvuden. Det går bra ända tills någon ny börjar, eller någon slutar — och då kryper onboardingen fram och en del av det institutionella minnet är bara en uppsägning från att försvinna för gott.

Uppgift. Målet var att få ut den kunskapen ur huvudena och in i dokumentation som folk faktiskt skulle hålla vid liv och använda: tydlig nog att läsas, strukturerad nog att underhållas i stället för att överges efter en månad.

Handling. Mycket av den skrevs för hand, runt 50 000 ord till slut, i Markdown i GitHub, Craft och Confluence beroende på var varje del hörde hemma. Den täckte arkitekturen, processerna och det praktiska instruktionsmaterialet — frågorna som folk ställde om och om igen. Den hölls versionshanterad och, lika viktigt, lätt att hitta, eftersom dokumentation som ingen kan hitta lika gärna kunde vara oskriven.

Resultat. Kunskapen slutade vara bräcklig. Nya medarbetare kom in i arbetet snabbare, processen blev något man kunde peka på i stället för att rekonstruera ur minnet, och helheten blev granskningsbar: man kunde se hur och varför arbetet gjordes i stället för att ta det på tro.

Kontakt

Håller ni fortfarande på att reda ut vad ni behöver?

Berätta vad som inte fungerar eller vad ni försöker bygga. Vi säger vad det skulle kräva, ungefär vad det skulle kosta och om vi är rätt personer för uppgiften.

Från 1 400 DKK i timmen, exklusive moms — och mindre per timme vid en längre bokning.

welcome@engineer.company +45 50 10 61 84 Köpenhamn, Danmark