Hvad er softwaredokumentation?
software henviser til rutiner og programmer, der er udviklet til et computersystem, der gør det muligt 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 fra producenten eller tredjepart. Dokumentation er en beskrivelse af et produkt, og hvordan man bruger det. Softwaredokumentation beskriver softwareapplikationer, og hvordan man bruger dem.
Trykket softwaredokumentation, sommetider benævnt softwaremanualer, er ofte indstillet 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 separate guider gives til de forskellige operativsystemer, som softwaren fungerer på, efter behov. Installationsvejledningen viser de specifikationer, der kræves for at køre softwaren, inklusive computeroperativsystem (er), RAM, harddiskplads, et internetforbindelsen og eventuelle andre krav eller tilføjelser, såsom perifere enheder. Dette følges med trin-for-trin-instruktioner til installation, der kan være fra en CD-ROM, en DVD eller en download, for eksempel. Eventuelle usædvanlige funktioner i installationsprogrammet og forklaringen af tilpassede installationsvalg, såsom alternative placeringer eller strømlinede installationer, forklares generelt.
En "hurtig start" -guide er ofte den næste del af den anvendte softwaredokumentation, der bruges. Når du henter, hvor installationsvejledningen forlader, hjælper Quick Start Guide brugeren med at komme i gang med softwaren og dens grundlæggende operationer. Dette afsnit kan arrangeres på forskellige måder, da de 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 softwaren afslutter nogle mini-mindre.
Andre elementer, som man ville udføret at finde i trykte softwaredokumentation inkluderer en komplet nedslidt af funktionerne, med vægt på funktioner, der er ny i den nyeste version; en liste over opdateringer siden de tidligere versioner, muligvis inklusive bugs faste; Oplysninger om, hvordan man får teknisk support; forklaringer på fejlmeddelelser; og information til avancerede eller "magt" -brugere. Spil og andre softwareapplikationer kan omfatte snyderi eller tip i deres dokumentation.
Printet software -dokumentation 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øjstips og hjælpe skæ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 ganske lidt i kvalitet, og dette gælder især softwaremanualer. De gode kan være fremragende, mens on ones, der ikke er veludført, kan efterlade brugerne med mange spørgsmål. Der er også brugere, der ikke gider at søge i dokumentationen, før de stiller spørgsmål om softwareproducentens fora.