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.
2022 – 2024

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.

Kategorier:
1Teamledning	/sv/categories/team-leadership/	engineer.company	70
1Tekniskt ledarskap	/sv/categories/technical-leadership/	engineer.company	70
1Mentorskap och coachning	/sv/categories/mentoring/	engineer.company	70
1Dokumentation	/sv/categories/documentation/	engineer.company	70

Tjänster:
1Tekniskt ledarskap och rådgivning	/sv/services/technical-leadership/	engineer.company	70
1Teknisk dokumentation	/sv/services/technical-documentation/	engineer.company	70

hDen här sidan på webben	URL:https://engineer.company/sv/portfolio/wrote-50000-words-of-software-documentation/	engineer.company	70
