Vad är mjukvarumokumentation?

Programvara hänvisar till rutiner och program som utvecklats 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 parter. Dokumentation är en beskrivning av en produkt och hur man använder den.Programvarudokumentation beskriver programvaruapplikationer och hur man använder dem.

Tryckt programdokumentation, ibland kallad programvaruhandböcker, är ofta inställda som en bok, med en titelsida, innehållsförteckning, kropp och index, och de har ofta oftaVissa typiska komponenter.Den första komponenten som de flesta användare behöver är en installationsguide, och separata guider ges för de olika operativsystemen som programvaran fungerar på efter behov.Installationsguiden visar specifikationerna som krävs för att köra programvaran, inklusive datoroperativsystem, RAM, hårddiskutrymme, en internetanslutning och andra krav eller tillägg, till exempel kringutrustning.Detta följs med steg-för-steg-instruktioner för installation, som kan komma från en CD-ROM, en DVD eller en nedladdning, till exempel.Alla ovanliga funktioner i installationsprogrammet och förklaringen av anpassade installationsval, såsom alternativa platser eller strömlinjeformade installationer, förklaras vanligtvis.

En "snabbstart" -guide är ofta nästa del av den tryckta mjukvarumokumentationen som används.När du plockar upp där installationsguiden lämnar, hjälper snabbstartguiden användaren att komma igång med programvaran och dess grundläggande operationer.Det här avsnittet kan ordnas på olika sätt, som passar den specifika programvaran.En populär metod för arbetsorienterade applikationer är en projektbaserad introduktion där användaren lär sig programvarans grundläggande funktionalitet samtidigt som man slutför några mini-lektioner.

Andra element som man kan förvänta sig att hitta i tryckt programdokumentation inkluderar en fullständig nedgång av funktionerna, med tonvikt på funktioner som är nya i den senaste versionen;en lista med uppdateringar sedan de tidigare versionerna, eventuellt inklusive buggar fixade;information om hur man får teknisk support;Förklaringar av felmeddelanden;och information för avancerade eller "kraft" -användare.Spel och andra programvaruapplikationer kan inkludera fuskark eller tips i deras dokumentation.

Tryckt mjukvarudokumentation är inte den enda typen.Först och främst kan den tryckta dokumentationen också vara tillgänglig online eller som PDF.Ytterligare dokumentation kan också vara tillgänglig i form av verktygstips och hjälpa skärmarna i själva applikationen, vanliga frågor och mdash;Listor över vanliga frågor tillsammans med svar, sökbara artiklar, webbutbildning, videor och andra format.

Programvarudokumentation 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 efter dokumentationen innan de ställer frågor på programvarutillverkarens forum.