Hopp til innhold
EngineerRådgivning
Meny
Design
Norsk bokmål

Engineer / Rådgivning / Portefølje

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.

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.

Kontakt

Avklarer dere fortsatt hva dere trenger?

Fortell oss hva som går galt, eller hva dere prøver å bygge. Vi sier hva det vil kreve, omtrent hva det vil koste, og om vi er de rette til oppgaven.

Fra 1 400 DKK timen, eksklusive mva. — og mindre per time ved et lengre oppdrag.

welcome@engineer.company +45 50 10 61 84 København, Danmark