# 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.

2022 – 2024

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.

Rolle: Produkteier og prosjektutviklingsleder
=> /nb/categories/team-leadership/ Kategorier: Teamledelse
=> /nb/categories/technical-leadership/ Kategorier: Teknisk ledelse
=> /nb/categories/mentoring/ Kategorier: Mentorarbeid og coaching
=> /nb/categories/documentation/ Kategorier: Dokumentasjon
=> /nb/services/technical-leadership/ Tjenester: Teknisk ledelse og rådgivning
=> /nb/services/technical-documentation/ Tjenester: Teknisk dokumentasjon

=> https://advisory.engineer.company/nb/portfolio/wrote-50000-words-of-software-documentation/ Denne siden på nettet
