Viktigheten av programvaredokumentasjon

Definisjon av programvaredokumentasjon

De tekniske, brukerhåndbøkene og andre instruksjoner som letter bruken og driften av et programvareprodukt eller -tjenester utgjør programvaredokumentasjonen, som kan omfatte (om nødvendig) kildekoden, feilkodene og deres betydning. Den kan eksistere i elektronisk format, som en PDF- eller CD-fil, eller som en bok.

Standarder for programvaredokumentasjon

Institute of Electrical and Electronic Engineering (IEEE) har designet standarder for dokumentasjon av programvareindustrien. Det kalles IEEE 1063-2001, "Standard for dokumentasjon av brukerprogramvare", og detaljer om innholdet, arkitekturen og viktigheten av en dokumentasjonsmanual for programvare. Den internasjonale organisasjonen for standardisering og Den internasjonale elektrotekniske kommisjonen (ISO og IEC, idem) har også etablert standarder for programvaredokumentasjon. Standardene deres kalles ISO / IEC 18019-2004 og ISO / IEC TR 9294. De omhandler henholdsvis dokumentasjon og programvarehåndtering. Hver av disse standardene understreker at dokumentasjon er en integrert del av programvarens livssyklus.

Funksjoner av programvaredokumentasjon

Alle programvarens livssyklusprosesser i utviklingen av programvare registreres som dokumentasjon. Dokumentasjonen fungerer som skriftlig informasjon om definisjon av krav, generelle systemspesifikasjoner, spesifikasjon av hver komponent og omfattende test- og vedlikeholdsplaner. Konfigurasjonsadministrasjonsverktøy er også veldig nyttige i programvaredokumentasjon.

Programvaredokumentasjon for utviklere

Viktigheten av dokumentasjon for utviklere ligger i det faktum at den første inneholder informasjon om driften av programvaresystemet. Denne informasjonen muliggjør reproduksjon av programvaren eller dens tilpasning til vedlikehold. Typen dokumentert informasjon er vanligvis verdt mye for programvareselskapet. Slik informasjon kan gå tapt hvis den ikke blir dokumentert, da utviklere kommer og går.

Programvaredokumentasjon for sluttbrukere

Sluttbrukerhåndbøker letter interaksjonen mellom brukeren og datamaskinen. En treningsmanual er et eksempel på en brukerorientert manual. Det reduserer læringstiden for den produktive bruken av programvaren, og sparer sluttbrukeren mye penger. Dokumentene til sluttbrukeren kan også være en referansehåndbok, som beskriver driften av systemet, eller en guide for systemadministratorer, som beskriver måten å betjene og vedlikeholde systemet på.

Interessante Artikler