Dit is hoe u de beste gebruikersdocumentatie bouwt

geplaatst in: Articles | 0

de kans is groot dat als uw producten complexer zijn dan een rol papieren handdoeken, u een soort gebruikersdocumentatie maakt om mensen te helpen leren hoe ze te gebruiken.

een goed ontworpen, gebruiksvriendelijke producthandleiding of gebruikershandleiding kan het verschil betekenen tussen een fantastische klantervaring en een verschrikkelijke ervaring.

en gebruikersdocumentatie is niet alleen voor nieuwe gebruikers.,

ervaren klanten kunnen ook verwijzen naar gebruikershandleidingen of productgidsen om hun herinneringen op te frissen over een functie die ze niet vaak hebben gebruikt of om een specifiek probleem op te lossen dat ze hebben.

voor dit bericht zullen we ons voornamelijk richten op best practices voor het maken van gebruikersdocumentatie voor niet-fysieke producten zoals software, maar de meeste, zo niet bijna al deze tips zijn ook van toepassing op het fysieke productrijk.

Hier is wat je zult leren:

  • Wat is gebruikersdocumentatie en waarom is het belangrijk?
  • Hoe de documentatie van de eindgebruiker deel uitmaakt van de klantervaring.,
  • Hoe goede gebruikersdocumentatie kan helpen om de last van uw klantenserviceteam te verlichten.
  • waarom visuele inhoud het geheime ingrediënt is voor de beste documentatie.
  • de essentiële elementen die de beste gebruikersdocumentatie garanderen.
  • De vier stappen voor het maken van documentatie die uw klanten verrukt en de tand des tijds doorstaan.

maak eenvoudig een gebruikershandleiding (gratis sjabloon)

Snagit ‘ s sjablonen zijn de snelste manier om gebruikershandleidingen te maken. Maak stapsgewijze handleidingen met een eenvoudige en professionele uitstraling.,

Download

Wat is gebruikersdocumentatie?

gebruikersdocumentatie (ook wel eindgebruikershandleidingen, eindgebruikershandleidingen, handleidingen, enz.) is de inhoud die u eindgebruikers biedt om hen te helpen succesvoller te zijn met uw product of dienst.

Dit zijn de instructiematerialen die bij uw product horen om iemand te helpen het correct te gebruiken of — in het geval van fysieke producten — zelfs samen te stellen.,

als u ooit een meubelstuk van Ikea hebt samengesteld, hebt u documentatie voor de eindgebruiker gebruikt.

dit is een goed voorbeeld van IKEA gebruikersdocumentatie. Zeer weinig tekst, maar duidelijke en eenvoudig te volgen diagrammen en visuele instructies over hoe het product te voltooien. ©Ikea

maar gebruikersdocumentatie neemt vele vormen aan.

Videospellen worden geleverd met handleidingen om je te vertellen welke knoppen je moet indrukken om de slechteriken neer te schieten. Software documentatie laat u zien wat uw aankoop kan doen en hoe het te doen.,

belastingformulieren worden geleverd met handleidingen over hoe ze correct in te vullen.

grasmaaiers en sneeuwwerpers hebben productgidsen om u te laten zien hoe u de motoren moet starten en waar u de brandstof moet bijvullen.

Ga naar hoe gebruikersdocumentatie te maken

Waarom is gebruikersdocumentatie belangrijk?

u weet dat uw product geweldig is. Je wilt dat je klanten het ook weten. Gebruikersdocumentatie helpt ervoor te zorgen dat uw klanten of gebruikers daadwerkelijk leren hoe ze het meeste uit uw product kunnen halen.,

of het nu gaat om het opslaan van een document, het starten van een motor, het gebruik van een specifiek gereedschap of belangrijke veiligheidsinformatie, uw documentatie voor eindgebruikers is een belangrijk onderdeel van uw relatie met uw klanten.

Recommended aanbevolen lezen: 9 Tips voor geweldige gebruikersdocumentatie (met voorbeelden)

het kan uw klanten verrukken

gebruikersdocumentatie is eenvoudig, toch? Ik bedoel, schrijf gewoon wat dingen over hoe je product te gebruiken en je bent klaar om te gaan!

Het is niet zo eenvoudig.

Het is meer dan alleen” how-to ” materiaal. Het maakt deel uit van de klantervaring., Dat betekent dat het ook marketingmateriaal is.

als consument heb ik zowel geweldige als vreselijke gebruikershandleidingen ervaren. Ik wed dat de meesten van jullie soortgelijke ervaringen hebben gehad.

een geweldige gebruikershandleiding of productgids laat uw klanten zien dat het u niet alleen interesseert of ze uw product kopen, maar of ze een echt geweldige ervaring hebben met het gebruik ervan.

en klanten die het gevoel hebben dat u om hen geeft buiten hun portemonnee, zullen steeds bij u terugkomen.,

als u wilt dat ze naar de wereld schreeuwen hoeveel ze van uw producten en diensten houden, is het verstrekken van geweldige gebruikersdocumentatie een essentieel onderdeel van die ervaring na aankoop.

Recommended Recommended Reading: 9 Tips voor geweldige gebruikersdocumentatie

hoe gebruikersdocumentatie uw ondersteuningsteam ondersteunt

mensen nemen contact op met uw ondersteuningsteam als iets niet werkt, maar bellen ook als ze iets niet kunnen achterhalen. Het hebben van geweldige gebruikersdocumentatie helpt uw ondersteuningsteam op twee belangrijke manieren.

1., Geeft ze een eenvoudige referentiegids

geweldige gebruikersdocumentatie hoeft niet alleen voor klanten te zijn. Uw product support team kan documentatie gebruiken om uw klanten beter te ondersteunen wanneer ze bellen. Wanneer u essentiële stukken zoals een inhoudsopgave of index opneemt, kunnen ze snel de informatie vinden die ze nodig hebben. En, als het een doorzoekbaar elektronisch document, dat is nog beter! We zullen hier later meer over leren in het artikel.

2. Reduceert oproepen

zoals hierboven vermeld, roepen mensen vaak ondersteuning wanneer ze iets niet kunnen achterhalen., Maar als klanten het zelf kunnen uitzoeken, hebben ze veel minder hulp nodig. In feite, meer dan 70 procent van de mensen de voorkeur aan de website van een bedrijf te gebruiken voor hulp in plaats van het gebruik van een telefoon of e-mail.

nu zal zelfs de beste documentatie niet al deze oproepen elimineren, maar het maken van gebruikershandleidingen en handleidingen die uitgebreid, gemakkelijk te begrijpen, duidelijk en beknopt zijn, zal een lange weg gaan om het totale volume van gesprekken, e-mails, chats, enz.te verminderen.

Wat zijn de essentiële elementen van goede gebruikersdocumentatie?,

hoewel elk product uniek is en verschillende elementen nodig heeft om echt geweldige gebruikersdocumentatie te maken, zijn er enkele best practices voor eindgebruikersdocumentatie die je hoe dan ook moet volgen.,

de gebruikers-documentatie moet het volgende omvatten:

  • eenvoudige taal
  • Eenvoud
  • Graphics
  • Een focus op het probleem
  • Een logische hiërarchie en flow
  • Een inhoudsopgave
  • Doorzoekbare inhoud
  • inhoud Toegankelijk te maken
  • een Goed ontwerp
  • Feedback van echte gebruikers
  • verwijzingen naar verdere bronnen

Duidelijke taal

Niets zal frustreren een klant meer dan het lezen van iets wat ze niet kunnen begrijpen. Niemand wil zich dom voelen., Het maken van uw klant het gevoel dat manier is zeker geen manier om een geweldige ervaring te bevorderen.

Gebruik waar mogelijk eenvoudige, eenvoudige taal om uw klanten te helpen zelfs de meest complexe concepten te begrijpen.

onthoud, schrijf voor de gebruiker, niet voor de ontwikkelaar.

Het klinkt als een no-brainer, maar schrijven in Gewone Taal over een product of dienst die je kent front-to-back is veel moeilijker dan je zou denken. Je kent allerlei jargon, acroniemen, en andere “insider” info die klanten waarschijnlijk niet. het is natuurlijk voor u om het te gebruiken.,

maar dat is waar je in ernstige problemen kunt komen.

neem niet aan dat uw klant iets over uw product Weet. Ga er niet van uit dat ze alle technische en/of industrie buzzwords kennen die u waarschijnlijk elke dag in uw kantoor gebruikt. Schrijf het voor hen.

schrijf niet alsof het kinderen zijn, maar begrijp dat ze extra hulp nodig hebben om ze echt op de hoogte te brengen. Schrijf de documentatie op een eenvoudig te lezen manier.

eenvoud

houd het zo eenvoudig mogelijk om zijn doel te bereiken. Dit geldt zowel voor de inhoud als voor de vormgeving van het document., Lange blokken tekst en pagina ‘ s vol met geschreven en grafische inhoud kunnen gebruikershandleidingen of handleidingen intimiderend en onvriendelijk maken.

klanten die geïntimideerd zijn door uw gebruikersmaterialen hebben veel meer kans om uw ondersteuningsteam te bellen voor hulp dan om zelf hun vragen op te lossen. En, ze zijn veel minder kans op een goede customer experience hebben.

Visuals, visuals, visuals

De beste gebruikersdocumentatie illustreert perfect het adagium, “show, don’ t tell.,”

Visuele Inhoud, inclusief afbeeldingen, geannoteerde schermafbeeldingen, afbeeldingen en video ‘ s, laat snel iemand zien hoe uw product werkt. Ze hoeven er niet over te lezen, ze kunnen het zien!

Recent onderzoek van TechSmith toont aan dat mensen visuele informatie sneller absorberen en taken beter uitvoeren wanneer instructies worden geleverd met visuele of video-inhoud.,

visuele inhoud helpt ook om lange tekstblokken te breken en kan helpen om veel tekst te elimineren die veel gebruikershandleidingen of handleidingen intimiderend en onaangenaam kunnen maken.

populaire manieren om visuele inhoud in gebruikersdocumentatie op te nemen zijn schermafbeeldingen, schermopnames, zelfstudie-video ‘ s en meer.

hebt u ooit gehoord van vereenvoudigde afbeeldingen?, Soms simplified user interface (of SUI) genoemd, vereenvoudigde graphics nemen beelden van een gebruikersinterface of andere grafische en — net zoals de naam al doet vermoeden — vereenvoudigt ze. Deze meer eenvoudige versie markeren de meest essentiële informatie, terwijl het verminderen van tekst en afbeeldingen die niet belangrijk zijn voor eenvoudigere vormen.,

Dus, iets dat er zo uitziet:

ziet er Nu als volgt:

Als ik probeerde te laten zien dat iemand u hoe u de Connect Mobile Device menu-item, de tweede afbeelding verwijdert alle rommel en kan de klant de ogen te richten waar ze moeten zijn.

de kans is groot dat u al vereenvoudigde afbeeldingen hebt gezien en het niet eens doorhad.,

zoals deze van G Suite Learning Center:

Er zijn veel tools beschikbaar, maar als u op zoek bent naar krachtige en eenvoudige manieren om screenshots en schermopnames te maken, raad ik u ten zeerste aan om een gratis proefversie van addertje onder het gras.

Oh, en hier is een professionele tip: Snagit kan vereenvoudigde afbeeldingen maken met slechts één klik!

Focus op het op te lossen probleem

elk product lost een probleem op., Maar te vaak, we zijn zo verliefd op onze coole Product functies, alles wat we willen doen is benadrukken wat het kan doen in plaats dat waarom onze klanten het nodig hebben.

zorg ervoor dat u gebruikers laat zien hoe taken met uw product moeten worden uitgevoerd.

natuurlijk heeft dit te maken met producteigenschappen, maar doe dit in de context van het helpen van de gebruiker om de reden te achterhalen waarom hij uw product heeft gekocht — om een specifiek probleem op te lossen.,

bijvoorbeeld, onze Camtasia en Snagit tutorials (Ja, tutorial video ‘ s kunnen een vorm van documentatie zijn) markeren specifieke functies, maar ze doen dit in de context van waarom iemand die functie zou kunnen gebruiken. Het gaat om het waarom, niet alleen het hoe.

Hier is een goed voorbeeld …

logische hiërarchie en stroom

goede documentatie heeft een hiërarchie van headings en subrubrieken nodig die een gebruiker laat weten wat elke sectie hen zal laten zien., En die hiërarchie moet een logische stroom volgen die de gebruiker helpt om uw product op de meest nuttige manier te gebruiken.

bijvoorbeeld, u wilt uw documentatie waarschijnlijk niet beginnen door uw klanten te laten zien hoe de meer geavanceerde functies te gebruiken zonder hen eerst de basisprincipes van hoe uw product werkt te laten zien. Begin met de eenvoudige dingen eerst en dan, als uw gebruikers bouwen hun kennis, laat ze de geavanceerde functies.,

inhoudsopgave

een inhoudsopgave biedt uw klanten een eenvoudige, efficiënte en vertrouwde manier om snel een oplossing te vinden voor hun vraag of probleem. Het staat aan het begin van het document zodat ze niet door pagina ‘ s met tekst hoeven te ziften om te vinden wat ze zoeken. Het moet alle hierboven beschreven hoofdrubrieken en subrubrieken omvatten.

Maak het doorzoekbaar

Er was een tijd dat de meeste gebruikersdocumentatie werd afgedrukt., Nu, in een tijdperk waarin bijna iedereen toegang heeft tot een smartphone, is het zinvoller om elektronische documentatie te maken. Dat betekent niet dat u ook geen printversies kunt maken, maar een elektronische versie biedt een aantal voordelen die we hieronder nader zullen toelichten.

net als een inhoudsopgave geeft doorzoekbare inhoud gebruikers gemakkelijker toegang tot uw inhoud en helpt ze zelf oplossingen te vinden.

toegankelijkheid

toegankelijke inhoud aanmaken., Dit betekent dat elektronische documentatie voldoet aan de toegankelijkheidsnormen voor mensen die blind of visueel gehandicapt zijn, doof of slechthorend zijn of cognitieve handicaps hebben.

onthoud dat veel van uw klanten dit nodig hebben om uw gebruikersdocumentatie te begrijpen en volledig toegankelijk te maken. Laat ze niet achter!

goed ontwerp

geef uw gebruikers een document dat ze willen bekijken en ze zullen het eerder gebruiken.

ontwerp materialen met uw klanten in gedachten. Maak het bruikbaar en vriendelijk., Vermijd lange tekstparagrafen of pagina ‘ s die te vol met inhoud zitten. Zorg voor witte ruimte om te helpen breken de eentonigheid en maken het vooruitzicht van het leren van een nieuw product minder ontmoedigend.

Voeg zoveel mogelijk afbeeldingen en afbeeldingen toe om uw klanten te laten zien in plaats van te vertellen hoe ze uw product moeten gebruiken. Gebruik voor elektronische documentatie video en GIF ‘ s.

gebruik consistente lettertypen en complementaire kleuren in meerdere documenten. Als uw organisatie een stijlgids heeft (die ik u ten zeerste aanraad), zorg er dan voor dat uw documentatie zich daaraan houdt.,

Snagit templates maakt het ongelooflijk eenvoudig om professioneel ogende gebruikersdocumentatie te maken van een reeks screenshots of andere afbeeldingen. Verzamel gewoon de afbeeldingen die je nodig hebt, kies Create en Image from Template en je bent onderweg.

Snagit wordt geleverd met een heleboel gratis, professioneel ontworpen sjablonen, en met TechSmith activa voor Snagit, krijg je toegang tot een ton meer!

Feedback van echte gebruikers en/of bètatesters

u kunt pas echt goede gebruikersdocumentatie maken als u hebt geluisterd naar de mensen buiten uw organisatie die de producten daadwerkelijk gebruiken.,

leer hun pijnpunten en probeer ze zo goed mogelijk aan te pakken. Ontdek wat ze u vertellen dat ze moeten weten om uw producten het beste te gebruiken. Hoewel het misschien voor de hand ligt, garandeer ik je dat je dingen leert die je nooit hebt overwogen.

Links naar andere documentatie

zorg ervoor dat uw klanten toegang hebben tot meer van de bronnen van uw organisatie over hoe succesvol te zijn met uw producten. Voor elektronische gebruikersdocumentatie kan dit zo eenvoudig zijn als het verstrekken van links naar tutorials, FAQ ‘ s, gebruikersforums en meer.,

maar zelfs afdrukdocumentatie kan dingen bevatten zoals websiteadressen en telefoonnummers voor verdere ondersteuning.

Bonus! Voeg stap-voor-stap instructies toe

stap-voor-stap handleidingen helpen om lange tekstblokken te vermijden en bieden een veel duidelijkere manier om een proces te tonen dan te proberen het alleen met tekst uit te leggen. Ze zijn gemakkelijker te volgen, gemakkelijker te begrijpen, en bieden een veel gebruiksvriendelijker ervaring dan gewoon iemand vertellen hoe een taak te voltooien.,

en vergeet niet, het opnemen van visuele inhoud in uw stap-voor-stap instructies maakt ze nog beter.

Snagit biedt een super-eenvoudig te gebruiken Stap-Tool die u helpt bij het maken van grote stap-voor-stap documentatie. Plus, de afbeeldingen combineren Tool kunt u individuele screenshots en andere afbeeldingen te combineren in een enkele afbeelding voor eenvoudiger bewerken en markeren.

Hoe maak je geweldige gebruikersdocumentatie

Stap 1: Plan

elke grote set gebruikersdocumenten begint met een plan., Hier zijn enkele tips over hoe te krijgen waar je heen gaat.

weet waar te beginnen

veel mensen gaan ervan uit dat als u uw product kent, u gewoon kunt beginnen met het maken van uw documentatie, maar er zit veel meer in. In plaats daarvan, beginnen met een plan om ervoor te zorgen dat u daadwerkelijk het helpen van uw gebruikers.

voordat u documentatie maakt, zijn hier een paar dingen om te overwegen:

  • Wat moet u opnemen? Wat moet je weglaten? (Hint: dit is waar feedback van gebruikers echt nuttig kan zijn!)
  • in welke volgorde moeten we de informatie presenteren?, (Herinner je essay contouren van de middelbare school? Gebruik ze!)
  • welke andere middelen zullen beschikbaar zijn? Hoe bieden we toegang/links naar deze?
  • Wie is verantwoordelijk voor het maken van het document? Wie is verantwoordelijk voor de feedback op het document? Wie heeft de definitieve goedkeuring?
  • moet dit vertaald of gelokaliseerd worden?

de antwoorden op deze vragen geven vorm aan hoe u uw documentatie aanmaakt. Planning zorgt voor een soepel proces en een beter gebruikersdocument.

Ken uw product

zorg ervoor dat u uw product kent.,

dat betekent niet dat je de absolute expert in alles moet zijn, maar iedereen die een gebruikershandleiding of gebruikershandleiding maakt, moet hands-on ervaring hebben met het product.

vertrouw op uw vakexperts voor de meer diepgaande kennis, zeker, maar u moet weten hoe u het zelf moet gebruiken voordat u probeert iemand anders te onderwijzen.

Kies uw formaat

bovendien is het uiteindelijke formaat van een document even belangrijk. Zal het alleen gedrukt worden? Zal het elektronisch zijn? Zo ja, waar zal het leven?,

Het was niet zo lang geleden dat bijna alle gebruikersdocumentatie alleen werd afgedrukt. Maar, tenzij je een zeer goede reden, Ik beveel ten minste met een elektronische versie beschikbaar op uw website.

De meeste gebruikers hebben 24 uur per dag toegang tot smartphones, computers of tablets, en ze zijn gewend om alles te vinden wat ze willen weten wanneer ze het willen weten. Door gebruikersbronnen online te zetten krijgen ze toegang waar ze ook zijn, wat betekent dat ze niet hoeven te zoeken in laden of archiefkasten om een gebruikershandleiding te vinden die ze al jaren niet meer hebben gezien.,

ook is het eenvoudig eenvoudiger om elektronische documentatie toegankelijk te maken voor mensen met een handicap. Een print-only versie werkt voor de meeste mensen, maar bent u bereid om een brailleversie te maken voor gebruikers die mogelijk blind of visueel gehandicapt zijn? Hoe zit het met gebruikers met een fysieke handicap waar het moeilijk voor hen is om objecten met hun handen te manipuleren?

Tools bestaan om elektronische documentatie voor iedereen toegankelijker te maken, maar print-only versies bieden een veel moeilijker toegankelijkheidsprobleem.,

Plus, elektronische documentatie is veel gemakkelijker te updaten, omdat het leeft op het web.

PDF: moet je wel of niet?

tenzij u wilt dat mensen uw documentatie afdrukken, maak er geen PDF van. In plaats daarvan, maak een elektronische versie beschikbaar op uw website als normale website tekst. Er zijn een aantal redenen voor, maar het komt allemaal neer op dit: het is gewoon gemakkelijker te gebruiken.

als u een downloadbare PDF-versie van uw documentatie wilt aanbieden, is dat prima. Maar zorg ervoor dat het beschikbaar is op uw website in een niet-PDF-formaat, ook.,

Stap 2: Maak uw gebruikersdocument

Als u alle vragen hebt beantwoord en alle hierboven beschreven beslissingen hebt genomen, is het tijd om uw gebruikersdocumentatie aan te maken. Ik ga niet veronderstellen om u te vertellen hoe precies de documentatie voor uw specifieke product te maken, maar er zijn een aantal belangrijke dingen om in gedachten te houden.

  • vermijd jargon en zeer technische termen, behalve wanneer het absoluut noodzakelijk is (en zorg er dan voor dat u ze definieert).
  • vermijd acroniemen tenzij u uitlegt wat ze betekenen.
  • gebruik waar mogelijk een algemeen erkende schrijfstijl zoals AP of Chicago., Als uw organisatie heeft een bedrijf Stijl Gids, gebruik dat.
  • neem niet aan dat de gebruiker iets weet over uw product of wat het doet. Laat ze zien wat ze moeten weten om succesvol te zijn.
  • vergeet niet om gewone taal te gebruiken. Schrijf voor de achtste klas. Zelfs voor gevorderde lezers leidt eenvoudige taal tot een snellere verwerking en een beter begrip.
  • het ontwerp moet aangenaam, niet-intimiderend zijn en de gebruiker aantrekken. Zorg ervoor dat ze uw documentatie willen gebruiken.,

Stap 3: Test het

een gebruikershandleiding is alleen goed als het uw klanten helpt uw product zo goed mogelijk te gebruiken. En dat Weet je pas als iemand het gebruikt. Voordat je nieuwe creatie de wereld in gaat, wil je het testen. Hier zijn een paar tips!

  • beste praktijk: geef het aan een groep echte gebruikers of bètatesters en kijk hoe ze het doen. Neem hun feedback op in het afgewerkte document.
  • Als u geen gebruikersfeedback voor bètatests hebt, test deze dan Intern, bij voorkeur met medewerkers die het minst bekend zijn met het product.,
  • Krijg feedback van de ontwikkelaars en ingenieurs. Ze kennen het product beter dan wie dan ook en ze kunnen wijzen op dingen die je misschien hebt gemist.

Stap 4: Houd uw documentatie up-to-date

wanneer uw product verandert, moet u alles up-to-date houden. Zoals hierboven vermeld, geeft dit elektronische documentatie een enorm voordeel ten opzichte van de druk. Echter, zelfs print-only documenten kunnen worden bijgewerkt en beschikbaar gemaakt voor download op uw website.

onthoud dat uw inhoud alleen goed is als het accuraat is. Zorg ervoor dat wat u uw klanten daadwerkelijk helpt hen uw product te gebruiken.,

samenvatting

Als u zich niets anders herinnert, houd er dan rekening mee dat geweldige gebruikersdocumentatie moet worden gemaakt, ontworpen en gepresenteerd op een manier die het meest nuttig is voor uw gebruikers.

geef ze documentatie die hen blijft verrassen en biedt het soort klantervaring dat u zou willen hebben.

maak uw documentatie toegankelijk, nuttig, maak het visueel.

maak eenvoudig een gebruikershandleiding (gratis sjabloon)

Snagit ‘ s sjablonen zijn de snelste manier om gebruikershandleidingen te maken. Maak stapsgewijze handleidingen met een eenvoudige en professionele uitstraling.,

Download

Veelgestelde vragen

Wat is gebruikersdocumentatie?

gebruikersdocumentatie (ook wel eindgebruikershandleidingen, eindgebruikershandleidingen, handleidingen, enz.) is de inhoud die u eindgebruikers biedt om hen te helpen succesvoller te zijn met uw product of dienst.

Wat zijn de soorten gebruikersdocumentatie?

in het verleden werd gebruikersdocumentatie gegeven via een help-bestand dat lokaal was op de machine van de gebruiker of via een fysieke handleiding of boekje., Tegenwoordig wordt gebruikersdocumentatie bijna altijd online aangeboden, wat heeft geholpen technische schrijvers meer verbeeldingskracht in hoe ze gebruikers helpen.

Wat is opgenomen in de gebruikersdocumentatie?

goede gebruikersdocumentatie moet omvatten: eenvoudige taal, eenvoud, visuals, een focus op het probleem, een logische hiërarchie en stroom, een inhoudsopgave, doorzoekbare inhoud, toegankelijke inhoud, goed ontwerp, feedback van echte gebruikers, en links naar andere bronnen.

Hoe maakt u een gebruikersdocument aan?,

Grote gebruikersdocumentatie kan in vier eenvoudige stappen worden gemaakt: Ken eerst uw doelen en maak een plan om ze te bereiken. Maak vervolgens
uw guide op basis van uw plan. Test dan uw gids om ervoor te zorgen dat het het werk doet voordat u het vrij te stellen. Tot slot, houd het up-to-date. Wanneer uw product verandert, werkt u uw documentatie bij om de wijzigingen weer te geven.

Opmerking: Dit bericht werd oorspronkelijk gepubliceerd in augustus 2019, maar werd bijgewerkt in September 2020 voor duidelijkheid en om nieuwe informatie op te nemen.

Geef een reactie

Het e-mailadres wordt niet gepubliceerd. Vereiste velden zijn gemarkeerd met *