Vad är programvarudokumentation? (med bilder)
Programvara hänvisar till rutiner och program utvecklade för ett datorsystem som gör att användningen kan utföra uppgifter eller på annat sätt interagera med datorn. Programvaran kan tillhandahållas av tillverkaren som en systemkomponent, eller skapas som separata applikationer av tillverkaren eller tredje part. Dokumentation är en beskrivning av en produkt och hur man använder den. Programvarudokumentation beskriver programapplikationer och hur man använder dem.
Utskriftsdokumentation, ibland kallad programvaruhandböcker, skapas ofta som en bok, med en titel, innehållsförteckning, karaktär och index, och de har ofta några typiska komponenter. Den första komponenten som de flesta användare behöver är en installationsguide, och separata guider ges för de olika operativsystem som programvaran fungerar efter behov. Installationsguiden visar specifikationerna som krävs för att köra programvaran, inklusive datoroperativsystem, RAM, hårddiskutrymme, en internetanslutning och alla andra krav eller tillägg, till exempel kringutrustning. Detta följs med steg-för-steg-instruktioner för installation, som till exempel kan komma från en CD-ROM, en DVD eller en nedladdning. Alla ovanliga funktioner i installationsprogrammet och förklaringar av anpassade installationsalternativ, till exempel alternativa platser eller strömlinjeformade installationer, förklaras generellt.
En ”snabbstartguide” är ofta nästa del av den utskrivna programvaruhandlingen som används. Med snabbstartguiden hjälper användaren att komma igång med programvaran och dess grundläggande operationer när plocka upp installationsinstallationen. Det här avsnittet kan ordnas på olika sätt, vilket passar den specifika programvaran. En populär metod för uppgiftsorienterade applikationer är en projektbaserad introduktion där användaren lär sig den grundläggande funktionaliteten för programvaran medan han slutför några minilektioner.
Andra element som man kan förvänta sig att hitta i tryckt programvarudokumentation inkluderar en fullständig nedläggning av funktionerna, med tonvikt på funktioner som är nya i den senaste versionen; en lista över uppdateringar sedan de tidigare versionerna, eventuellt inklusive fixade buggar; information om hur man får teknisk support; förklaringar av felmeddelanden; och information för avancerade eller “ström” användare. Spel och andra mjukvaruapplikationer kan innehålla fuskark eller tips i sin dokumentation.
Dokumentation om tryckt programvara är inte den enda typen. Först och främst kan den tryckta dokumentationen också finnas tillgänglig online eller som pdf. Ytterligare dokumentation kan också finnas i form av verktygstips och hjälpskärmar i själva applikationen, vanliga frågor - listor med vanliga frågor tillsammans med svar, sökbara artiklar, webbutbildning, videor och andra format.
Programvara dokumentation varierar ganska mycket i kvalitet, och detta gäller särskilt programvaruhandböcker. De goda kan vara utmärkta, medan de som inte är väl genomförda kan lämna användare med många frågor. Det finns också användare som inte kommer att bry sig om att söka i dokumentationen innan de ställer frågor på programvarutillverkarens forum.