Delprosjekt: Kvalitetssikring
- Ansvarlig:
- Ole Haakon Neskvern (ole.h.neskvern@hiof.no)
Eirik
Rogne (eirik.rogne@hiof.no)
- Innledning:
- Omfanget av Al Mashriq er så stort at vi ble nødt til
å finne rutiner for hvordan arbeidet med dette prosjektet skulle
foregå.
- Hva har vi gjort:
- Vi har laget en egen side for hvordan kvalitetssikringen skal
gjennomøres på dette prosjektet. Denne har fungert som en
referanseside for utviklerne i prosjektet, og var ment å besvare
praktiske spørsmål under utvikling og vedlikehold av
prosjektet.
- Siden beskriver hvordan
dokumenter (temporære, ferdigutviklede og maler) og
programmer/script skal skrives for å ivareta kvalitetssikringen.
- Prosjektgruppen fra 1996 har organisert alt stoffet iht. Dewey - Decimal Classification Edition 19, og vi
så ikke noen grunn til å forandre på dette.
- På grunnlag av eksisterende stoff har vi laget egne maler som skal benyttes
når mer stoff skal legges ut.
- I tillegg ble det bestemt følgende:
- Weblint kjøres på alle nye html-sider som lages, samt
ved større endringer i et dokument. Kommandoen er weblint
[htmldokument]. Feilmeldinger av typen unknown element ... kan
ignoreres.
- Relative linker skal benyttes i alle referanser
- Alle dokumentene bør inneholde en skjult tag som forteller om
hvem som editerte filen sist.
- Nye dokumenter linkes opp fra tilhørende hovedfilene og legges
til filen New additions/changes
(~/almashriq/base/latest.html).
- Erfaringer:
- Kvalitetssikring er viktig! Vi la kanskje ikke nok vekt på dette da vi startet prosjektarbeidet, noe som har resultert i en del ekstra arbeid. Manglende rutiner for skriving av dokumentasjon kunne med fordel ha vært definert på et tidligere tidspunkt.
- Mulige forbedringer:
- Lage rutiner og prosedyrer for hvordan kvalitetssikring skal ivaretas når nytt stoff legges ut, samt for hvordan dokumentasjon skal skrives.
- Prosjektfakta
- Lokalisering/programvare:
- Webxref ligger i /usr/local/bin
- Weblint ligger i /usr/local/bin/weblint
|