een gebruikershandleiding, of gebruikershandleiding, is een technisch communicatiedocument dat is ontworpen om gebruikers te informeren over een bepaald product. Geproduceerd in druk of digitaal, kunnen ze worden geschreven over bijna elk product, maar zijn het meest gebruikelijk met computer software en hardware, elektronische apparaten, en video games.
gewoonlijk geschreven door technische schrijvers of productontwerpers, is het doel de gebruikers te informeren en hen te helpen problemen met betrekking tot het product op te lossen. Als een essentieel onderdeel van productdistributie, kan de kwaliteit van uw handleiding een grote impact hebben op de algehele klantervaring, daarom wilt u het goed doen!
In dit artikel zal ik tips delen over het schrijven van een gebruikershandleiding die informatie duidelijk aan uw klanten overbrengt, en u laten zien hoe u het schrijfproces in Zenkit kunt organiseren.
Tips voor het schrijven van een gebruikershandleiding
er zit veel in het schrijven van een gebruikershandleiding. Van functiebeschrijvingen tot reparatie-instructies, tot alle juridische details en veiligheidswaarschuwingen. Hier zijn enkele tips om in gedachten te houden als het gaat om het schrijven:
- Ken uw doel
elke gebruikershandleiding moet een doel hebben. Vaak, het is om gebruikers te helpen problemen met betrekking tot uw product op te lossen, maar met dat je moet ook beslissen hoe je wilt om hen te helpen. Als je eenmaal hebt besloten over de hoek die u wilt nemen, splitsen de informatie in secties en stap-voor-stap instructies die eenvoudig genoeg zijn om te volgen.
- Bepaal de gebruiker
het is noodzakelijk om het soort publiek te kennen dat uw gebruikershandleiding zal lezen, omdat het van invloed zal zijn op hoe u het schrijft. Het kennen van je gemiddelde gebruiker kan je een idee geven van de taal die je moet gebruiken bij het schrijven van de gebruikershandleiding, het formaat en de algehele stijl. Bijvoorbeeld, schrijven voor tech-savvy IT-specialisten zal heel anders zijn dan schrijven voor ouders met jonge gezinnen.
- gebruik toegankelijke taal
ongeacht wie uw doelgroep is, de taal van de tekst van de gebruikershandleiding moet toegankelijk zijn voor zelfs de meest niet-technische persoon. Je moet aannemen dat de lezer heeft nul kennis over uw product, dus het moet begrijpelijk, duidelijk en beknopt zijn. Het moet de lezer aanspreken en het gebruik van jargon moet worden beperkt.
- Maak het visueel
het is bekend dat mensen visuele gegevens 60.000 keer sneller verwerken dan tekst, daarom wilt u dat uw gebruikershandleiding afbeeldingen bevat. Gebruikershandleidingen bevatten bijna altijd relevante afbeeldingen bij de tekst. Sommige producten delen zelfs screenshot beelden van stap-voor-stap instructies of zijn gewoon puur beelden (IKEA handleidingen zijn beroemd tekstvrij). Beelden kunnen echt helpen om de boodschap die u wilt communiceren met uw lezer over te brengen.
- vindbaarheid verbeteren
zie het onder ogen, niemand zal de hele gebruikershandleiding lezen, dus voor lezers om er waarde in te vinden, moet je het eenvoudig genoeg maken voor mensen om er doorheen te skimen en te vinden wat ze zoeken. Geef het een schoon formaat door het hebben van een consistente lay-out van pagina tot pagina en zorg ervoor dat er veel ruimte tussen stukjes tekst. Gebruik bekende trefwoorden met betrekking tot het product en zorg ervoor dat het lettertype is eenvoudig en leesbaar.
hoe plant u uw gebruikershandleiding
Zenkit is een geweldig hulpmiddel voor het plannen van een gebruikershandleiding. De project management tool zit boordevol functies waarmee u gegevens kunt verzamelen en vervolgens structureren om een geoptimaliseerde workflow te creëren. Hier zijn de stappen om uw gebruikershandleiding schrijfproces te organiseren.
Stap 1:
Meld u aan voor een gratis Zenkit-account en log in.
Stap 2:
zodra u uw profiel hebt aangepast, klikt u op “nieuwe collectie”, geeft u uw collectie een naam en drukt u op enter of “create”. U wordt doorgestuurd naar de standaard kanban-weergave.
u kunt uw verzameling een klein teken geven door er een pictogram voor aan te passen. Om dit te doen, klik op de titel van de collectie, selectie “maatwerk”, en kies de kleuren en het pictogram logo dat u wilt.
ik ben persoonlijk een fan van het gebruik van een kanban bord om visueel in kaart te brengen van een projectplan. Het visual scheduling systeem is ideaal voor het identificeren van knelpunten en problemen die kunnen ontstaan tijdens het planningsproces. Het kan u ook een kristalhelder overzicht geven van hoe uw project vordert.
de Kanban-weergave toont u drie standaardkolommen met het opschrift “taak, in uitvoering en gereed”. U kunt de kolommen hernoemen door simpelweg op een van de labelnamen te klikken en naar de naam sectie te gaan in het menu venster dat verschijnt. Om meer stadia toe te voegen aan uw workflow, alles wat je hoeft te doen is klikken op “+ Voeg fase”, geef de kolom een label, en klik op “create” of druk op enter.
natuurlijk kunt u zoveel stadia selecteren als u wilt voor uw workflow en labelen ze wat u passend vindt. De etappes waar ik voor ging zijn de volgende:
- Info & Resources
- Feedback & instructies
- secties
- Concepten
Stap 3:
zodra de structuur van uw workflow is bepaald, kunt u beginnen met het toevoegen van andere elementen als items onder elke kolom.
zoals ik aan het begin van dit artikel al zei, bevat een project als het schrijven van een gebruikershandleiding veel inhoud; Inhoud die moet worden opgesplitst in verschillende hoofdstukken en secties, en secties van secties.
de subitems van Zenkit zijn de perfecte functie voor het opsplitsen van grotere taken in kleinere. Een van de 12 aangepaste velden van onze project management tool, het presenteert al uw items op een gestructureerde manier, zodat u in staat bent om te werken met een beheersbare tijdlijn.
om een subitem aan een van uw items toe te voegen, klikt u op het item om het te openen. Klik vervolgens op de ” + “teken dat zich boven het commentaar sectie, selecteer dan “aangepast veld”. Onder de” Type “sectie, scroll naar beneden en selecteer het” subitems ” veld. Vergeet niet om het veld een naam te geven!
Stap 4:
om verdere structuur aan uw workflow toe te voegen, kunt u de hiërarchieweergave van Zenkit gebruiken. Om deze weergave in uw collectie te activeren, klikt u op “Kanban” (of de naam van de weergave waarin u zich bevindt) die u in de rechterbovenhoek vindt en selecteert u “nieuwe weergave”. Een menu extensie moet pop-up en selecteer “hiërarchie”.
Stap 5:
wanneer u de hiërarchieweergave voor het eerst gebruikt, zult u merken dat uw items niet verbonden zijn. U kunt ze verbinden door elk item te slepen en neer te zetten op het hoofdhiërarchie Paneel. Als u een bovenstaand item sleept, zult u merken dat de subitems mee zullen komen.
de hiërarchie die aan een item wordt toegewezen, hangt af van waar u het plaatst. Bijvoorbeeld, items gesleept naar de top zal een niveau een hiërarchie en items die onder een andere worden gesleept zal veranderen in een subitem van dat item.
de hiërarchieweergave toont u elk item dat u aan de hiërarchie van uw items hebt toegevoegd door inkepingen te gebruiken om aan te geven wanneer een item een subitem wordt. U kunt alleen een overzicht krijgen van Toptaken of alles in uw project tegelijk zien door de items in te klappen of te openen.
andere soorten tekstdocumenten en-materialen plannen
net als het plannen van een gebruikershandleiding, kan Zenkit worden gebruikt om andere tekstzware documenten of materialen te plannen. De hiërarchie view en subitem functie zijn perfect voor het plannen van elk project dat het organiseren van een grote hoeveelheid inhoud die moet worden opgesplitst in verschillende secties, zoals een roman of een college thesis vereist.
plan voor het schrijven van een roman
het schrijven van een roman kan jaren duren om te voltooien, daarom is het een goed idee om iets te hebben om het allemaal op te schrijven. Met behulp van een soortgelijke sjabloon aan de handleiding gids, kunt u uw roman hoofdstuk voor hoofdstuk structureren en bijhouden van alle karakter, plot, en thema details in één platform.
Thesis / dissertatieplan
van onderwerp-ideeën tot onderzoek tot het verzamelen van gegevens, het schrijven van een thesis of proefschrift vereist veel planning. Door Zenkit te gebruiken om alles te beheren, kan het u helpen om uw thesis op tijd af te krijgen en ervoor te zorgen dat u iets belangrijks niet over het hoofd ziet!
Klik hier om ons proefschrift/proefschrift Planning template te gebruiken.
een geweldige gebruikershandleiding geeft de lezer duidelijk informatie zodat hij eventuele problemen met het product kan oplossen. Met behulp van Zenkit om het schrijfproces te plannen, en gebruik te maken van de hiërarchie view en subitem functie, kan u helpen om een kwaliteit gebruikershandleiding die uw klanten de best mogelijke ervaring kan geven produceren.
wat was de laatste gebruikershandleiding die u nuttig vond?
Cheers,
Dinnie en het Zenkit-Team