1 Kor vi dokumenterer
Cerebrum dokumenterer på mange forskjellige stader:
- Cerebrum-repoet - for teknisk dokumentasjon retta mot utviklarar. Skript må inneholde nok hjelpetekst for at Cerebrum drift skal kunne bruke verktøya.
- Dokumentasjons-repoet - for all informasjon som er retta mot omverda. Dette vert synkronisert over til Cerebrum utvikling sine nettsider.
- Sidene under IT-tjenester for Brukernavn, passord og brukeradministrasjon - Vi har ansvar for å holde informasjonen for brukarar på UiO oppdatert når endringar i Cerebrum påvirker brukarane og IT-tilsette.
TODO: Vi har fleire andre stader enn dette. Noter ned alle.
2 Retningslinjer
TODO: Vi har hatt et lengre diskusjon om valg rundt dokumentering for Cerebrum. Dette er referert, men må leggast inn her.
3 Krav til dokumentasjon av webservices
UAIT har satt krav til dokumentasjon frå eksterne når vi skal kommunisere med deira WS. Vi har dei samme krava for oss sjølve:
- WSDL må vere gitt.
- Skriftlig beskrivelse av korleis tenesta kan brukast.
- Eksempelkode for alle funksjonar.
Alle desse punkta må kunne delast ut ved behov.
Dette er basert på Microsoft: Documenting Your Web Service.