Har skrevet 50.000 ord softwaredokumentation
Har skrevet 50.000 ord omfattende softwaredokumentation med Markdown
i GitHub, Craft og Confluence og derved sikret fastholdelse af viden
og gennemsigtighed i processen.
2022 – 2024

Situation. Det meste af det, der var vigtigt at vide om produktet og
om teamets måde at arbejde på, lå i folks hoveder. Det går fint,
lige indtil der kommer en ny, eller nogen rejser — og så går
onboardingen i sneglefart, og en bid af organisationens hukommelse
er én opsigelse fra at forsvinde for altid.

Opgave. Målet var at få den viden ud af hovederne og ind i
dokumentation, som folk rent faktisk ville tage vare på og bruge:
klar nok til at blive læst og struktureret nok til at blive
vedligeholdt i stedet for at blive opgivet efter en måned.

Handling. En stor del af den blev skrevet manuelt, i alt omkring
50.000 ord, i Markdown i GitHub, Craft og Confluence, alt efter hvor
hver del hørte hjemme. Den dækkede arkitekturen, processerne og det
praktiske vejledningsmateriale — svarene på de spørgsmål, folk blev
ved med at stille. Den blev holdt under versionsstyring og, lige så
vigtigt, gjort let at finde, for dokumentation, som ingen kan finde,
kan lige så godt ikke eksistere.

Resultat. Videnen blev robust i stedet for skrøbelig. Nye
medarbejdere kom hurtigere i gang, processen blev noget, man kunne
pege på i stedet for at rekonstruere efter hukommelsen, og det hele
blev muligt at revidere: man kunne se, hvordan og hvorfor arbejdet
blev udført, i stedet for at tage det for gode varer.

Kategorier:
1Teamledelse	/da/categories/team-leadership/	advisory.engineer.company	70
1Teknisk ledelse	/da/categories/technical-leadership/	advisory.engineer.company	70
1Mentoring & coaching	/da/categories/mentoring/	advisory.engineer.company	70
1Dokumentation	/da/categories/documentation/	advisory.engineer.company	70

Ydelser:
1Teknisk ledelse & rådgivning	/da/services/technical-leadership/	advisory.engineer.company	70
1Teknisk dokumentation	/da/services/technical-documentation/	advisory.engineer.company	70

hDenne side på nettet	URL:https://advisory.engineer.company/da/portfolio/wrote-50000-words-of-software-documentation/	advisory.engineer.company	70
