Programvare dokumentasjon gjennomsyrer software livssyklus . Det er den synlige del av programvaren prosessen. Uten det , kan programvaren ikke opprettholdes . Uten det, kan brukerne ikke trene , og de nesten ikke kan bruke programvaren . Uten den nye utviklere måtte re -oppfinne hjulet i programvareutvikling. Dokumentasjonen for programvaren er den viktigste manifestasjonen av programvare. Det er guiden gjennom programvaren labyrint. Definisjon av Programvare Dokumentasjon
Tekniske manualer , brukerveiledninger og andre instrukser som forenkler bruk og drift av en programvare produkt eller tjenester utgjør dokumentasjonen for programvaren . Denne dokumentasjonen kan inneholde der det er nødvendig , kildekoden , feilkoder og deres betydninger . Dokumentasjonen for programvaren kan også finnes i elektronisk format , som en PDF -fil , som en CD eller som en bok.
Software Documentation Standards
Instituttet for elektro og elektronikk ( IEEE ) har utviklet standarder for programvareindustrien programvare dokumentasjon. Kalt IEEE 1063-2001 , "Standard for Software brukerdokumentasjon , " Dette dokumentet beskriver innhold, arkitektur og viktigheten av en programvare dokumentasjon manual . The International Standards Organization ( ISO ) og Den internasjonale elektrotekniske standardiseringsorganisasjon ( IEC ) har også satt standarder for programvare dokumentasjon. Deres standarder kalles ISO /IEC 18019-2004 og ISO /IEC TR 9294 . De tar programvare dokumentasjon og dets ledelse henholdsvis . Hver av disse standardene understreker at dokumentasjonen for programvaren er en integrert del av programvaren livssyklus .
Funksjoner av Software Documentation
All programvare livssyklus prosesser i utvikling av programvare føres som programvare dokumentasjon. Dokumentasjonen for programvaren fungerer som skriftlig informasjon om krav definisjoner , samlet system spesifikasjoner , spesifikasjon av hver komponent og den omfattende test-og vedlikeholdsplaner . Konfigurasjonsstyring verktøy er også svært nyttig i dokumentasjonen for programvaren .
Programvare Dokumentasjon for utviklere
Betydningen av programvare dokumentasjon til programvareutviklere ligger i det faktum at dokumentasjonen for programvaren inneholder informasjon om driften av programvaren system . Denne informasjonen gjør det mulig å reprodusere programvaren eller tilpasse det til vedlikehold.Den type informasjon dokumentert er vanligvis verdt millioner til programvaren selskapet . Slik informasjon kan gå tapt hvis ikke dokumentert som utviklere kommer og går.
Programvare Dokumentasjon for sluttbrukere
Software Documentation hjelper sluttbrukere sette pris på programvaren raskere .
End - brukermanualer forenkle samspillet av sluttbruker med datamaskinen . Opplæringsmanual er et eksempel på en bruker - orientert håndboken. Det reduserer læring tid til produktiv bruk av programvaren , og dermed sparer sluttbrukeren millioner av dollar. Sluttbruker dokumenter kan også være en referanse manual som beskriver arbeidet i system eller et system administrator Instruksjon at detaljer hvordan å operere og vedlikeholde systemet .
