Wat is softwaredocumentatie?

Software verwijst naar routines en programma's die zijn ontwikkeld voor een computersysteem dat het gebruik mogelijk maakt om taken uit te voeren of anderszins met de computer te communiceren.De software kan door de fabrikant worden verstrekt als systeemcomponent, of als afzonderlijke applicaties door de fabrikant of derden worden gemaakt. Documentatie is een beschrijving van een product en hoe het te gebruiken.Softwaredocumentatie beschrijft softwaretoepassingen en hoe deze te gebruiken.

Gedrukte softwaredocumentatie, soms aangeduid als softwarehandleidingen, worden vaak ingesteld als een boek, met een titelpagina, inhoudsopgave, body en index, en ze hebben vaak hebbenEnkele typische componenten.De eerste component die de meeste gebruikers nodig hebben, is een installatiegids en afzonderlijke gidsen worden gegeven voor de verschillende besturingssystemen waarop de software werkt, indien nodig.De installatiegids geeft een overzicht van de specificaties die nodig zijn om de software uit te voeren, inclusief computerbesturingssystemen, RAM, harde schijfruimte, een internetverbinding en andere vereisten of add-ons, zoals randapparatuur.Dit wordt gevolgd met stapsgewijze instructies voor installatie, die mogelijk afkomstig zijn van een CD-ROM, een dvd of een download bijvoorbeeld.Alle ongebruikelijke kenmerken van het installatieprogramma en uitleg van aangepaste installatiekeuzes, zoals alternatieve locaties of gestroomlijnde installaties, worden in het algemeen uitgelegd.

Een handleiding "Snelle start" is vaak het volgende deel van de gebruikte softwaredocumentatie.De Quick Start Guide gaat verder op waar de installatiegids weggaat en helpt de gebruiker aan de slag met de software en de basisbewerkingen.Deze sectie kan op verschillende manieren worden gerangschikt, zoals bij de specifieke software past.Een populaire methode voor taakgeoriënteerde applicaties is een projectgebaseerde introductie waarbij de gebruiker de basisfunctionaliteit van de software leert terwijl sommige mini-minderons worden voltooid.

Andere elementen die men zou verwachten te vinden in gedrukte softwaredocumentatie, omvatten een complete run-down van de functies, met de nadruk op functies die nieuw zijn in de nieuwste versie;een lijst met updates sinds de vorige versies, mogelijk opgelost bugs;informatie over het verkrijgen van technische ondersteuning;uitleg van foutmeldingen;en informatie voor geavanceerde of "power" -gebruikers.Games en andere softwareapplicaties kunnen cheatbladen of hints in hun documentatie zijn.

Gedrukte softwaredocumentatie is niet de enige soort.Allereerst kan de gedrukte documentatie ook online of als PDF beschikbaar zijn.Aanvullende documentatie kan ook beschikbaar zijn in de vorm van tooltips en helpen schermen binnen de applicatie zelf, FAQS MDASH;Lijsten met veelgestelde vragen samen met antwoorden, doorzoekbare artikelen, webtraining, video's en andere formaten.

Softwaredocumentatie varieert nogal wat in kwaliteit, en dit geldt met name voor softwarehandleidingen.De goede kunnen uitstekend zijn, terwijl degenen die niet goed worden uitgevoerd, gebruikers met veel vragen kunnen laten.Er zijn ook gebruikers die niet de moeite nemen om de documentatie te doorzoeken voordat ze vragen stellen op de forums van de softwarefabrikant.