Parenteser

Betraktninger fra Mat-teamets grønne enger

Hvem bør skrive dokumentasjonen?

Hvem bør skrive dokumetasjonen? Den som skrev koden? Noen andre? Hvorfor?

Personen som har skrevet biblioteket som ble løst har hatt problemet, og kjenner løsningen. Men etter at koden er skrevet, er det ikke sikkert man husker hvordan problemet føltes før man hadde løsningen i hånden.

Hva med en ny bruker av biblioteket? Som ny kan man beskrive læringsreisen. En utfordring er at det man beskriver som del av egen læringsreise gjerne er litt feil: mens man lærer har man ikke helhetsblikket.

Jeg synes Scicloj har en spennende prosess her:

  1. Daniel Slutsky samler folk som er interessert i å lære å bruke et bibliotek og personer som kjenner biblioteket og teorien.
  2. Sammen skriver man et utkast til et dokument som forklarer problemet.
  3. Utkastet deles fritt på internett og står som uoffisielt fram til det er godt nok.

Kanskje samme teknikk kunne blitt brukt flere steder?

Teodor