Wat is softwaredocumentatie?
Software verwijst naar routines en programma's die zijn ontwikkeld voor een computersysteem waarmee gebruikers taken kunnen uitvoeren of anderszins met de computer kunnen communiceren. De software kan door de fabrikant worden geleverd als een systeemcomponent, of worden gemaakt als afzonderlijke applicaties door de fabrikant of derden. Documentatie is een beschrijving van een product en hoe het te gebruiken. Softwaredocumentatie beschrijft softwareapplicaties en hoe deze te gebruiken.
Gedrukte softwaredocumentatie, soms softwarehandleidingen genoemd, wordt vaak opgezet als een boek, met een titelpagina, inhoudsopgave, hoofdtekst en index, en ze bevatten vaak enkele typische componenten. Het eerste onderdeel dat de meeste gebruikers nodig hebben, is een installatiehandleiding en afzonderlijke handleidingen worden gegeven voor de verschillende besturingssystemen waaraan de software werkt, indien nodig. De installatiehandleiding bevat de specificaties die nodig zijn om de software uit te voeren, inclusief computerbesturingssystemen, RAM, ruimte op de harde schijf, een internetverbinding en andere vereisten of add-ons, zoals randapparatuur. Dit wordt gevolgd door stapsgewijze installatie-instructies, bijvoorbeeld van een CD-ROM, een DVD of een download. Alle ongebruikelijke functies van het installatieprogramma en uitleg over aangepaste installatiekeuzes, zoals alternatieve locaties of gestroomlijnde installaties, worden over het algemeen uitgelegd.
Een "snelstartgids" is vaak het volgende deel van de gebruikte gedrukte softwaredocumentatie. De snelstartgids gaat verder waar de installatiehandleiding stopt en helpt de gebruiker aan de slag met de software en de basisbewerkingen. Dit gedeelte kan op verschillende manieren worden gerangschikt, afhankelijk van de specifieke software. Een populaire methode voor taakgerichte toepassingen is een projectgebaseerde introductie waarin de gebruiker de basisfunctionaliteit van de software leert tijdens het voltooien van enkele minilessen.
Andere elementen die men zou verwachten te vinden in gedrukte softwaredocumentatie omvatten een volledige run-down van de functies, met de nadruk op functies die nieuw zijn voor de nieuwste versie; een lijst met updates sinds de vorige versies, inclusief mogelijk opgeloste bugs; informatie over het verkrijgen van technische ondersteuning; uitleg van foutmeldingen; en informatie voor gevorderde of "krachtige" gebruikers. Games en andere softwaretoepassingen kunnen cheatsheets of hints in hun documentatie opnemen.
Gedrukte softwaredocumentatie is niet de enige soort. Allereerst is de gedrukte documentatie mogelijk ook online of als pdf beschikbaar. Aanvullende documentatie kan ook beschikbaar zijn in de vorm van tooltips en helpschermen in de applicatie zelf, FAQ's - lijsten met veelgestelde vragen samen met antwoorden, doorzoekbare artikelen, webtraining, video's en andere formaten.
Softwaredocumentatie varieert nogal van kwaliteit, en dit geldt met name voor softwarehandleidingen. De goede kunnen uitstekend zijn, terwijl degenen die niet goed zijn uitgevoerd gebruikers met veel vragen kunnen achterlaten. Er zijn ook gebruikers die niet de moeite nemen om de documentatie te doorzoeken voordat ze vragen stellen op de forums van de softwarefabrikant.