Hoe kan ik een gebruikershandleiding voor software te schrijven

Een vrouw werkt aan een computer . kleurenblind Images / Blend Images / Getty Images

vaak gevuld met jargon, acroniemen en aanwijzingen dat een Ph.D nodig om te begrijpen, software handleidingen worden soms geschreven vanuit het oogpunt van een ontwikkelaarin plaats van een gebruiker.Hierdoor kan de gids veronderstellingen over vaardigheidsniveau van de lezer die vaak onjuist maken.De eerste stap in het schrijven van een goede handleiding is om de eigenlijke schrijfproces zo ver mogelijk van de ingenieurs mogelijk.


De softwareontwikkelaar weet meer dan wie dan ook wat maakt de software het werk, maar dat betekent niet dat de ontwikkelaar moet de gids te schrijven.Integendeel, het is een duidelijk nadeel.Belangrijker dan een diep begrip van de innerlijke werking van de software is een begrip van wie de eindgebruiker zal zijn, wat zijn opleidingsniveau is, en hoe dat de eindgebruiker zal worden met behulp van de software.In de meeste gevallen hoeft de eindgebruikers niet nodig om de finesses van de programmering en de back-end wer

king van de software weten - ze hoeven alleen maar te weten hoe het te gebruiken om hun werk gemakkelijker te maken.

Gebruiker Testing

  • De handleiding moet grotendeels taak-georiënteerd zijn, in plaats van zwaar beschrijvend.Omdat de handleiding is geschreven om gebruikers te helpen begrijpen hoe specifieke taken uit te voeren, de schrijver moet begrijpen van die taken als goed, en als resultaat, die door elke afzonderlijke stap van elke functie is absoluut noodzakelijk.Het is niet noodzakelijk dat de schrijver noodzakelijkerwijs weten hoe het programma werd van een ontwerp of ontwikkeling oogpunt, maar het is essentieel om een ​​sterke kennis van alle functies.Tijdens het uitvoeren van elke taak, neem de tijd elke stap, waaronder klikken, drop-down menu's, en andere acties op te schrijven.

het interview proces

  • Hoewel de ontwikkelaar niet de ene naar de handleiding te schrijven zou moeten zijn, zal ze nog steeds een waardevolle bron aan de schrijver te zijn, en voor het schrijven begint, plan een kickoff meeting tussen de schrijver, ontwikkelaar eningenieurs, en potentiële eindgebruikers te helpen het werk van de schrijver op de hoogte van het begin.Interviews met vakspecialisten en ingenieurs moeten worden opgenomen, met transcripties gemaakt voor latere referentie.

Imagery

  • Een handleiding moet te veel tekst niet.Integendeel, nemen liberale gebruik van graphics en het scherm clips.Beschrijving van een actie is veel duidelijker met tekstgebaseerde richtingen gepaard met een scherm clip die duidelijk illustreert dat richting.Omvatten zowel vóór en na, om te laten zien hoe het scherm eruit ziet voordat het nemen van elke actie, en wat gebeurt er na de actie is ondernomen.Een eenvoudige screen capture tool zoals de Knipprogramma opgenomen in Microsoft Windows werkt goed voor het vastleggen van deze beelden.Zorg ervoor dat elk beeld nummer, en beschikken over een titel die kort beschrijft.Centreren direct onder de paragraaf die eerste introduceert het concept weergegeven in de afbeelding.

Formatting

  • Communiceren duidelijk in een technisch document vereist planning en een zorgvuldige naleving van normen in de gids.Standaarden in zowel presentatie, taal, en nomenclatuur hulp te vermijden verwarring.Sjablonen zijn beschikbaar en kan een goed uitgangspunt voor uniformiteit, hoewel deze wel kunnen worden aangepast aan de situatie.Met behulp van een one-inch marge met een enkele kolom beste past bij de behoefte om afbeeldingen toe te voegen;een twee-kolom instelling zou kunnen lijken te druk, en kan de plaatsing van de beelden verwarrend te maken.

Versiebeheer en Tracking

  • Meer dan enig ander type document, een software-handleiding is waarschijnlijk te gaan door middel van meerdere iteraties voordat het compleet is, en het is waarschijnlijk te gaan door middel van een review proces door meerdere belanghebbenden.Met behulp van de functie Wijzigingen bijhouden op Microsoft Word is een gemakkelijke manier om bij te houden van de reacties en veranderingen van elk individu te houden.Het creëren van meerdere versies na elke beoordeling cyclus, elk met een andere bestandsnaam, helpt ook het proces mee en zorgt ervoor dat alle belanghebbenden zijn tevreden met het eindresultaat.

Resources

  • Techcommunicators.com: Schrijven Vervroegde Handleidingen
703
0
1
Product Management