Vaak gevuld met jargon, acroniemen en aanwijzingen die een Ph.D vereisen om te begrijpen, worden softwaregebruikershandboeken soms geschreven vanuit het gezichtspunt van een ontwikkelaar in plaats van een gebruiker. Dientengevolge kan de gids veronderstellingen doen over het niveau van de lezer die vaak onjuist zijn. De eerste stap bij het schrijven van een goede gebruikershandleiding is om het daadwerkelijke schrijfproces zo ver mogelijk bij de ingenieurs vandaan te halen.
De softwareontwikkelaar weet als geen ander wat de software doet werken, maar dat betekent niet dat de ontwikkelaar de handleiding moet schrijven. Integendeel, het is een duidelijk nadeel. Belangrijker dan een diep begrip van de interne werking van de software is een goed begrip van wie de eindgebruiker zal zijn, wat zijn opleidingsniveau is en hoe die eindgebruiker de software zal gebruiken. In de meeste gevallen hoeven eindgebruikers de fijnere programmapunten en de back-end-werking van de software niet te kennen - ze moeten gewoon weten hoe ze deze moeten gebruiken om hun werk gemakkelijker te maken.
Gebruikerstests
De gebruikershandleiding moet grotendeels taakgericht zijn, in plaats van zwaar beschrijvend. Omdat de handleiding is geschreven om gebruikers te helpen begrijpen hoe specifieke taken moeten worden uitgevoerd, moet de schrijver ook inzicht hebben in die taken en als gevolg daarvan is het essentieel om door elke afzonderlijke stap van elke functie te gaan. Het is niet noodzakelijk dat de schrijver noodzakelijkerwijs weet hoe het programma is gemaakt vanuit een ontwerp- of ontwikkelingsoogpunt, maar het is essentieel om over een sterke praktische kennis van alle functies te beschikken. Neem tijdens het uitvoeren van elke taak de tijd om elke stap op te schrijven, inclusief klikken, vervolgkeuzemenu's en andere acties.
Het interviewproces
Hoewel de ontwikkelaar niet degene moet zijn die de handleiding moet schrijven, zal ze nog steeds een waardevolle bron voor de schrijver zijn en voordat het schrijven begint, een aftrapvergadering plannen tussen de schrijver, ontwikkelaar en ingenieurs en mogelijke eindgebruikers om de het werk van de schrijver vanaf het begin. Interviews met materiedeskundigen en ingenieurs moeten worden vastgelegd, met transcripties die worden gemaakt voor latere referentie.
Imagery
Een gebruikershandleiding mag niet te zwaar zijn. Integendeel, neem liberaal gebruik van grafische afbeeldingen en schermclips op. Beschrijving van een actie is veel duidelijker met op tekst gebaseerde aanwijzingen, vergezeld van een schermclip die die richting duidelijk illustreert. Neem zowel voor als na de weergave op, om te laten zien hoe het scherm eruit ziet voordat u elke actie uitvoert, en wat er gebeurt nadat de actie is ondernomen. Een eenvoudig hulpprogramma voor het vastleggen van schermen, zoals de Snipping Tool in Microsoft Windows, werkt goed voor het vastleggen van deze afbeeldingen. Zorg ervoor dat u elke afbeelding een nummer geeft, en voeg een bijschrift toe dat het kort beschrijft. Centreer het direct onder de alinea die als eerste het concept introduceert dat in de afbeelding wordt weergegeven.
opmaak
Duidelijk communiceren in een technisch document vereist planning en zorgvuldige naleving van normen in de hele handleiding. Normen in zowel presentatie, taal en nomenclatuur helpen verwarring voorkomen. Sjablonen zijn beschikbaar en kunnen een goed startpunt zijn voor uniformiteit, hoewel deze zeker kunnen worden aangepast aan elke situatie. Het gebruik van een marge van één inch met een enkele kolom past het best bij de behoefte om afbeeldingen toe te voegen; een instelling met twee kolommen kan te druk lijken en kan plaatsing van afbeeldingen verwarrend maken.
Versioning en Tracking
Meer dan enig ander type document zal een softwarehandleiding waarschijnlijk meerdere iteraties doorlopen voordat deze is voltooid en waarschijnlijk door een beoordelingsproces van meerdere belanghebbenden gaan. Het gebruik van de functie Wijzigingen bijhouden in Microsoft Word is een eenvoudige manier om de opmerkingen en wijzigingen van elke persoon bij te houden. Het creëren van meerdere versies na elke beoordelingscyclus, elk met een andere bestandsnaam, helpt ook het proces en zorgt ervoor dat alle belanghebbenden tevreden zijn met het eindresultaat.
