Mjukvara
Kodnära dokumentation
Gränssnitt och flöden beskrivna och uppdaterade när koden ändras, i stället för en wiki som ljuger.
Så jobbar du i Colleag
- 1
Be kollegan beskriva ett flöde eller gränssnitt.
- 2
Kollegan läser befintlig dokumentation och ändringarna och utkastar beskrivningen.
- 3
Granska mot implementationen.
- 4
Godkänn; vid nästa ändring föreslår kollegan uppdateringen.
Ett exempel
“Beskriv hur synkflödet mot molnet fungerar efter senaste ändringen.”
En uppdaterad flödesbeskrivning med det som ändrats markerat, byggd på den gamla beskrivningen och ändringarna. Där koden och dokumentet sa emot varandra flaggas det i stället för att väljas tyst.
Skärmbild från Colleag. Exemplet använder påhittade siffror.
Underlaget
- Befintlig flödesdokumentation
- Ändringarna sedan beskrivningen skrevs
- Gränssnittsdokument
Du godkänner
Allt kollegan tar fram är förslag med källor. Inget publiceras, skickas eller sparas i arkivet utan att en människa godkänt det, och varje siffra går att spåra till sitt underlag.
Nyfiken på hur det känns?
Vi kör pilotprogram med ett fåtal tillverkande bolag i taget. Berätta om er verksamhet så visar vi vad kollegorna kan göra med just era dokument och er data.