Hvad er softwaredokumentation? (med billeder)
Software henviser til rutiner og programmer, der er udviklet til et computersystem, der tillader brugen at udføre opgaver eller på anden måde interagere med computeren. Softwaren kunne leveres af producenten som en systemkomponent eller oprettes som separate applikationer af producenten eller tredjepart. Dokumentation er en beskrivelse af et produkt, og hvordan det bruges. Softwaredokumentation beskriver softwareprogrammer, og hvordan man bruger dem.
Printet softwaredokumentation, sommetider benævnt softwaremanualer, er ofte opstillet som en bog med en titelside, indholdsfortegnelse, krop og indeks, og de har ofte nogle typiske komponenter. Den første komponent, som de fleste brugere har brug for, er en installationsvejledning, og der gives separate guider til de forskellige operativsystemer, softwaren fungerer efter behov. Installationsvejledningen viser de specifikationer, der kræves for at køre softwaren, herunder computeroperativsystem (er), RAM, harddiskplads, en internetforbindelse og eventuelle andre krav eller tilføjelser, såsom perifere enheder. Dette følges med trin-for-trin-instruktioner til installation, som f.eks. Kan være fra en cd-rom, en dvd eller en download. Eventuelle usædvanlige funktioner i installationsprogrammet og forklaring af brugerdefinerede installationsvalg, såsom alternative placeringer eller strømlinede installationer, forklares generelt.
En "hurtig start" -guide er ofte den næste del af den anvendte dokumentationssoftwaredokumentation. Med hurtigstartguiden hjælper brugeren med at komme i gang med softwaren og dens grundlæggende handlinger, når installationsguiden går væk. Dette afsnit kan arrangeres på forskellige måder, der passer til den bestemte software. En populær metode til opgaveorienterede applikationer er en projektbaseret introduktion, hvor brugeren lærer den grundlæggende funktionalitet af softwaren, mens han afslutter nogle mini-lektioner.
Andre elementer, som man kunne forvente at finde i trykt softwaredokumentation, inkluderer en komplet nedslidning af funktionerne med vægt på funktioner, der er nye i den nyeste version; en liste over opdateringer siden de foregående versioner, muligvis inklusive fejl rettet; information om, hvordan man får teknisk support; forklaringer på fejlmeddelelser; og information til avancerede eller “magt” -brugere. Spil og andre softwareprogrammer kan indeholde snyderark eller tip i deres dokumentation.
Udskrivet softwaredokumentation er ikke den eneste slags. Først og fremmest kan den trykte dokumentation også være tilgængelig online eller som en pdf. Yderligere dokumentation kan også være tilgængelig i form af værktøjstip og hjælpeskærme i selve applikationen, ofte stillede spørgsmål - lister over ofte stillede spørgsmål sammen med svar, søgbare artikler, webtræning, videoer og andre formater.
Softwaredokumentation varierer en hel del i kvalitet, og det gælder især softwaremanualer. De gode kan være fremragende, mens dem, der ikke er udført godt, kan efterlade brugere med mange spørgsmål. Der er også brugere, der ikke gider at søge i dokumentationen, før de stiller spørgsmål på softwareproducentens fora.