Software dokumentation gennemsyrer software livscyklus . Det er den synlige del af software proces . Uden den kan softwaren ikke opretholdes. Uden det, kan brugerne ikke træne , og de stort set ikke kan bruge softwaren. Uden den nye udviklere skulle genopfinde hjulet i softwareudvikling. Software dokumentation er den vigtigste manifestation af software. Det er guide gennem software labyrint. Definition af Software Documentation
Tekniske manualer, brugervejledninger og andre instrukser , som letter brugen og driften af et software- produkt eller tjenester udgør dokumentationen til softwaren . Denne dokumentation kan indeholde nødvendigt kildekoden, fejlkoder og deres betydninger. Software Dokumentationen kan også findes i elektronisk format , som en PDF -fil , som en cd eller som en bog.
Software Documentation Standards
institut for elektrisk og elektronisk teknik (IEEE ) har designet standarder for software-industrien software dokumentation. Kaldet IEEE 1063-2001 , "Standard for Software User Documentation ," Dette dokument indeholder oplysninger om indholdet , arkitektur og betydning af et software dokumentation manual. International Standards Organization (ISO ) og Den Internationale Elektrotekniske Kommission (IEC) også har sat standarder for software dokumentation. Deres standarder kaldes ISO /IEC 18019-2004 og ISO /IEC TR 9294 . De behandler software dokumentation og dens ledelse hhv . Hver af disse standarder understreger, at dokumentationen til softwaren er en integreret del af software livscyklus.
Funktioner af Software Documentation
Alle software livscyklus processer i udvikling af software registreres som software dokumentation. Software dokumentation tjener som skriftlige oplysninger om krav definitioner, systembesparelse specifikationer , specifikation af hver komponent , og den omfattende test-og vedligeholdelsesplaner . Configuration management værktøjer er også meget nyttige i softwarens dokumentation.
Software Dokumentation for udviklere
Betydningen af software dokumentation softwareudviklere ligger i det faktum , at software dokumentationen indeholder oplysninger på driften af software system. Denne information gør det muligt at gengive de software eller tilpasse den til maintenance.The type oplysninger dokumenteret er normalt værd millioner til software firma. Sådanne oplysninger kan gå tabt, hvis ikke er dokumenteret som udviklere kommer og går.
Software Dokumentation for End- Users
Software Dokumentation hjælper slutbrugere værdsætter software hurtigere.
End - brugermanualer letter interaktionen af slutbrugeren med computeren. En træningsmanual er et eksempel på en bruger -orienteret manual. Det reducerer læring tid til produktivt brug af softwaren , og dermed spare slutbrugeren millioner dollars. Slutbrugerattester dokumenter kan også være en reference manual , der beskriver funktionen af systemet eller en systemadministrator retningslinier , som beskriver, hvordan at drive og vedligeholde systemet .
