Hoe te gebruikersdocumentatie maken

schrijven van documentatie over hoe een computer te gebruiken programma is van cruciaal belang voor zowel de eindgebruiker en iedereen die probeert om mensen te trainen op het nieuwe programma.De documentatie moet duidelijk en gemakkelijk te begrijpen zijn.Je wilt niet dat uw gebruikers moeten gissen naar hoe u uw programma te gebruiken.Gebruikersdocumentatie heeft een balans van zowel de geschreven en visuele stappen.De volgende stappen zal een overzicht van hoe je een standaard gebruiker gids te creëren bieden.

wat je nodig hebt

  • Computerprogramma
  • Potlood en papier
  • Desktop publishing software

instructies

  1. Schrijf een korte beschrijving van uw nieuwe programma --- omvatten het doel, welke platformen het programma wordt uitgevoerd en welke eisen het geheugen.Een lijst van verschillende bullet points met vermelding van de belangrijkste kenmerken van het programma.

  2. Schets hoe u wilt dat de gebruiker de documentatie om te kijken.Omvatten event

    uele kop- en voetteksten in de documentatie, pagina nummers en hoe de omslag eruit moet zien te plaatsen.Dit overzicht zal u ook helpen met het assembleren van de gids samen.

  3. Schrijf je eerste deel - hoe het programma te installeren.Staat elke stap duidelijk uit het plaatsen van de compact disk in de computer wat te doen zodra de software is geïnstalleerd.Bieden screen shots van het installatieproces.Niet verlaten uit elke stappen en een lijst van eventuele fouten die zich kunnen voordoen.Onder meer een overzicht van tips voor het oplossen.

  4. staat duidelijk de stappen voor het verkrijgen van het programma te draaien.Omvatten die het pictogram te klikken en wat het hoofdscherm eruit zal zien.Zorg voor een screenshot van het openingsscherm.

  5. Schrijf je derde deel - hoe om te werken met het programma.Beschrijf elke menufuncties, hoe om te helpen toegang te krijgen indien beschikbaar, hoe je bestanden op te slaan, hoe u kunt afdrukken, hoe het programma en alle andere basisfuncties te verlaten.Onder andere screenshots in dit gedeelte ook.Gebruik eenvoudig Engels en verwacht niet dat de eindgebruiker om iets te veronderstellen.Als het programma-interfaces met een ander programma of de verpakking, leg deze verbinding.

  6. Stel een eenvoudige inhoudsopgave en een index met trefwoorden van uw documentatie.Schrijf dit gedeelte als je eenmaal de bovenstaande kernsecties gedaan.De index geeft de gebruiker een snelle manier om informatie op te halen zonder dat u de hele handleiding te zoeken.

  7. Maak een verklarende woordenlijst voor technische woorden of jargon dat nodig is voor de gebruiker worden gedefinieerd.Vervolgens wordt het ontwerp van de afdekking te gaan op de voorzijde van de gids.

  8. bewerken documentatie - controleer uw spelling, grammatica en de totale stroom van informatie.Maak eventuele herzieningen en laat de documentatie over aan iemand anders om dubbel te controleren uw werk.Printen en binden de definitieve versie.

Resources

  • Methoden en Mechanica van Creëren Betrouwbare gebruikersdocumentatie
338
0
0
Andere Computer Software