Betydningen af ​​softwaredokumentation

Definition af softwaredokumentation

De tekniske, brugermanualer og andre instruktioner, der letter brugen og betjeningen af ​​et softwareprodukt eller -tjenester, udgør softwaredokumentationen, som (om nødvendigt) kan omfatte kildekoden, fejlkoder og deres betydning. Det kan eksistere i elektronisk format, som en PDF- eller CD-fil eller som en bog.

Standarder for softwaredokumentation

Institute of Electrical and Electronic Engineering (IEEE) har designet standarder til dokumentation af softwareindustrien. Det kaldes IEEE 1063-2001, "Standard til brugersoftwaredokumentation" og indeholder detaljer om indholdet, arkitekturen og betydningen af ​​en softwaredokumentationsmanual. Den internationale organisation for standardisering og Den Internationale Elektrotekniske Kommission (ISO og IEC, idem) har også etableret standarder for softwaredokumentation. Deres standarder kaldes ISO / IEC 18019-2004 og ISO / IEC TR 9294. De beskæftiger sig med henholdsvis dokumentation og softwarehåndtering. Hver af disse standarder understreger, at dokumentation er en integreret del af softwarens livscyklus.

Funktioner af softwaredokumentation

Alle software-livscyklusprocesser i udviklingen af ​​enhver software registreres som dokumentation. Dokumentationen fungerer som skriftlig information om definition af krav, generelle systemspecifikationer, specifikation af hver komponent og omfattende test- og vedligeholdelsesplaner. Konfigurationsstyringsværktøjer er også meget nyttige i softwaredokumentation.

Softwaredokumentation til udviklere

Betydningen af ​​dokumentation for udviklere ligger i det faktum, at den første indeholder oplysninger om driften af ​​softwaresystemet. Denne information muliggør gengivelse af softwaren eller dens tilpasning til vedligeholdelse. Den type dokumenterede oplysninger er normalt meget værd for softwarevirksomheden. Sådanne oplysninger kan gå tabt, hvis de ikke dokumenteres, da udviklere kommer og går.

Softwaredokumentation til slutbrugere

Slutbrugervejledninger letter interaktionen mellem brugeren og computeren. En træningsmanual er et eksempel på en brugerorienteret manual. Det reducerer læringstiden for den produktive brug af softwaren, hvilket sparer slutbrugeren en masse penge. Slutbrugerens dokumenter kan også være en referencehåndbog, der specificerer driften af ​​systemet eller en guide til systemadministratorer, der specificerer måden, hvorpå man betjener og vedligeholder systemet.

Interessante Artikler