Skrev 50 000 ord programvaredokumentasjon
Skrev 50 000 ord grundig programvaredokumentasjon i Markdown i GitHub, Craft og Confluence, og sikret dermed at kunnskapen ble bevart og prosessen gjennomsiktig.
Arbeidet utført: 2022 – 2024
50,000 ord med dokumentasjon, så kunnskapen ble værende
Situasjon. Det meste som betydde noe om produktet og om hvordan teamet jobbet, satt i hodene på folk. Det går fint helt til noen nye begynner, eller noen slutter — og da går onboardingen i sneglefart, og en god del av organisasjonens hukommelse er én oppsigelse unna å forsvinne for godt.
Oppgave. Målet var å få den kunnskapen ut av hodene og inn i dokumentasjon som folk faktisk ville ta vare på og bruke: tydelig nok til å bli lest, strukturert nok til å bli vedlikeholdt i stedet for å bli lagt bort etter en måned.
Handling. Mye av den ble skrevet for hånd, rundt 50 000 ord til slutt, i Markdown fordelt på GitHub, Craft og Confluence etter hvor hver del hørte hjemme. Den dekket arkitekturen, prosessene og det praktiske veiledningsstoffet — spørsmålene folk stadig stilte. Den ble holdt under versjonskontroll og, like viktig, var lett å finne, fordi dokumentasjon som ingen finner, like gjerne kunne vært uskrevet.
Resultat. Kunnskapen sluttet å være sårbar. Nye folk kom raskere i gang, prosessen ble noe man kunne peke på i stedet for å rekonstruere fra hukommelsen, og det hele ble etterprøvbart: man kunne se hvordan og hvorfor arbeidet ble gjort, i stedet for å ta det på tro.

Foto: rawpixel / Pixabay 
Foto: JayMantri / Pixabay
Bruk erfaringen i prosjektet deres
Bruk «Skrev 50 000 ord programvaredokumentasjon» som utgangspunkt for en lignende utfordring i organisasjonen deres. Tjenestene bak arbeidet er tilgjengelige for prosjektet deres. Noen på din side av bordet når en leverandør, et budsjett eller en arkitekturbeslutning trenger en ny, kyndig vurdering.
Se bak resultatet
Les om situasjonen, beslutningene og resultatet i eksemplet. Vi kan drøfte hva som passer deres rammer, og hva som krever en annen tilnærming. Skrev 50 000 ord programvaredokumentasjon — 50,000 ord med dokumentasjon, så kunnskapen ble værende
Se tilbake på Designet og styrte 5 000 timer med kartutvikling. Les videre: Samlet inn og analyserte forretningskrav. Eller ta en titt på hele porteføljen.
Ett stykke av en lengre oversikt — og den ligger i sin helhet her.
Hver oppføring er skrevet på samme måte: situasjonen, oppgaven, hva vi gjorde, og hva som endret seg.

