Hoppa till innehållet

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.

50,000 ord dokumentation, så att kunskapen stannade kvar

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.

  • Gammal skrivmaskin, alfabet
    Foto: rawpixel / Pixabay
  • Bokhylla, bibliotek, litteratur
    Foto: JayMantri / Pixabay

Använd erfarenheten i ert projekt

Använd ”Skrev 50 000 ord programvarudokumentation” som utgångspunkt för en liknande utmaning i er organisation. Tjänsterna bakom arbetet finns tillgängliga för ert projekt. Någon på din sida av bordet när en leverantör, en budget eller ett arkitekturbeslut behöver en andra välgrundad åsikt.

Se våra tjänster Hör av er

Se bakom resultatet

Läs om situationen, besluten och resultatet i exemplet. Vi kan diskutera vad som passar era förutsättningar och vad som kräver ett annat angreppssätt. Skrev 50 000 ord programvarudokumentation — 50,000 ord dokumentation, så att kunskapen stannade kvar

Se våra tjänster Hör av er

En del av en längre historik — och den finns i sin helhet här.

Varje post är skriven på samma sätt: situationen, uppgiften, vad vi gjorde och vad som förändrades.

Se hela historiken

Definiera förbättringen ni behöver

Ta med beslutet, människorna som berörs och alternativen som övervägts. Vi kan tydliggöra avvägningarna och lämna en dokumenterad rekommendation.

Se vad det kostar Hör av er

Försvinner kunskap när folk går vidare?

Fråga om besluten bakom ”Skrev 50 000 ord programvarudokumentation”. Ni talar med personer som kan förklara arbetet och bedöma ert eget projekt.

Se våra tjänster
welcome@engineer.company +45 50 10 61 84 Köpenhamn, Danmark
QR-kod för 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.
Ta med dig den här sidanhttps://advisory.engineer.company/sv/portfolio/wrote-50000-words-of-software-documentation/