Hoe om duidelike en bondige gebruikershandleidings te skryf
Wat is 'n gebruikershandleiding?
Daar is verskeie name vir 'n gebruikershandleiding. Tegniese dokumente, onderhoudshandleidings en instruksiehandleidings is almal name wat na dieselfde item verwys. 'n Gebruikershandleiding word gemaak om kliënte te help om jou produk of diens korrek te gebruik of probleme op te los wat tydens gebruik gebeur. Hulle kan in druk, digitaal of albei formate beskikbaar gestel word.
Gebruikshandleidings voorsien die eindgebruiker van omvattende, stap-vir-stap instruksies en 'n mate van ondersteuning vir probleme. 'n Inhoudsopgawe moet in elke gebruikershandleiding teenwoordig wees, want dit is naslaanmateriaal eerder as boeke wat van begin tot einde gelees moet word. Jy moet 'n vinnige begin- of opstarttutoriaal in jou gebruikershandleiding byvoeg sodat gebruikers maklik op hul gemak kan voel om die produk te begin gebruik.
soorte gebruikershandleidings
Vir 'n verskeidenheid onderwerpe en doelwitte kan gebruikershandleidings vervaardig word. Hier is 'n paar van jou moontlikhede, so kom ons kyk daarna.
- Instruksie Handleiding
'n Instruksiehandleiding is 'n tipe gebruikersgids wat eenvoudige instruksies bied vir die gebruik van 'n produk op die manier waarop dit bedoel was om gebruik te word. - Opleidingshandleiding
Hierdie soort gebruikersgids bied 'n lys riglyne vir die voltooiing van 'n sekere taak, projek of werk. - Dienshandleiding
Dienshandleidings is gebruikersgidse wat beskryf hoe om 'n stuk masjinerie of toerusting op verskillende plekke op te pas en in stand te hou.tages van sy lewensduur. - Gebruikershandleiding
Gebruikershandleidings is tegniese publikasies wat verduidelik hoe om 'n produk behoorlik te gebruik of te bedryf. - Bedryfshandleiding
Rolle, pligte en prosedures spesifiek vir 'n besigheid of organisasie word in bedryfshandleidings beskryf. - Handleiding vir organisasiebeleid
'n Handleiding vir organisasiebeleid is die dokumentasie wat 'n maatskappy se beleid, praktyke en beste praktyke definieer. - Standaard Bedryfsprosedures (SOP's) Handleiding
Gebruikers trek voordeel uit 'n standaard bedryfsprosedurehandleiding se gedetailleerde instruksies vir die uitvoer van gevestigde prosedures.
Hoekom het jou besigheid gebruikershandleidings nodig?
Mense is beter toegerus om probleme op hul eie te hanteer met die ondersteuning van 'n gebruikershandleiding. 'n Ordentlike gebruikershandleiding kan jou kliënte die gereedskap gee wat hulle nodig het om vinnig en effektief die waarde te bereik wat hulle van jou produk of diens verlang in vandag se onmiddellike bevredigingskultuur.
Uitstekende kliëntediens moet aangevul word met gebruikershandleidings. Die skryf van uitstekende gebruikershandleidings sal die volgende advan verskaftages vir jou maatskappy:
- Om aanboord en opleiding makliker te maak
Goedgeskrewe gebruikersgidse kan die aanboord- en opleidingsprosedures eenvoudiger maak. Dit is korrek, deur die ontwikkeling en implementering van topgebruikershandleidings, sal beide jou werknemers en jou verbruikers voordeel trek.
Jou maatskappy kan gebruikersgidse gebruik om nuwe werknemers te help om deur sommige van die prosesse en stelsels te gaan wat deel is van hul nuwe rolle eerder as om net moeilike persoonlike opleidingsessies op te stel, wat aansienlike tyd en finansiële uitgawes inhou. Omdat werknemers kan leer terwyl hulle die pligte verwant aan hul posisies uitvoer as gevolg van die gebruikersgidse, kan daar minder ure verlore gaan tydens aanboord. - Om ondersteuningsuitgawes te verminder
Gebruikersgidse is 'n goeie toevoeging tot u kliëntedienspogings vir die verbruiker, maar dit dien ook die besigheidseienaar goed as 'n komponent van die kliëntediensstelsel.
Kliënte is meer geneig om dadelik oplossings te vind en is minder geneig om 'n tegnikus of verteenwoordiger te kontak vir gespesialiseerde ondersteuning wanneer jy hulle vinnige toegang gee tot 'n soekbare gebruikersgids. - Om tyd te bespaar
Beide jou kliënte en jou werknemers, van intreevlakpersoneel tot bestuur, kan tyd bespaar deur gebruikershandleidings te gebruik. Wanneer gebruikershandleidings vir jou kliënte beskikbaar is, hoef hulle nie tyd te mors om inligting te kry oor hoe om 'n produk te gebruik nie, want hulle sal dadelik direkte toegang tot daardie inligting hê.
Wanneer jou werknemers toegerus is met nuttige gebruikershandleidings, hoef hulle nie tyd te mors om onafhanklik na oplossings te soek of die aandag van hul kollegas en bestuurders te monopoliseer met navrae nie, want hulle het toegang tot die oplossings reg in hul gebruikershandleiding! - Om aanspreeklikheid te minimaliseer
Een benadering om te demonstreer dat jy jou produk deeglik getoets het en weet hoe om dit veilig te gebruik, is om gebruikershandleidings te skryf en te versprei. Dit kan enige verpligtinge wat verband hou met die vervaardiging van iets vir die algemene publiek aansienlik verlaag.
Om waarskuwings en veiligheidsmaatreëls neer te skryf en toeganklik te maak vir gebruikers via 'n gebruikersgids is 'n effektiewe (hoewel nie onfeilbare) manier om regsprobleme te vermy wat verband hou met beserings of ander skade wat veroorsaak word deur misbruik as die produk wat jy verkoop gevaarlik vir gebruikers kan wees (dink ruimteverwarmers, elektriese gereedskap, ens.).
Watter komponente vorm die beste gebruikershandleidings?
Daar is 'n paar beste praktyke vir eindgebruikersdokumentasie om aan te voldoen, maak nie saak wat nie, al is elke produk uniek en sal verskillende komponente benodig om werklik uitstekende gebruikersdokumentasie te genereer.
- Gewone taal
Niks sal jou kliënte meer irriteer nie - behalwe om nie een te bied nie - as om te ontdek dat hul gebruikershandleiding vol jargon en moeilik verstaanbare taal is. Jou gebruikersinstruksies is moeilik om te gebruik as gevolg van hierdie taalkeuses, wat ook nie uitstaande kliëntediens bevorder nie. Om seker te maak dat jy vir die gebruiker skryf, nie vir die ontwikkelaar nie, is 'n deurslaggewende komponent om wonderlike gebruikersgidse te skep. Moenie aanvaar dat jou eindgebruiker enigiets weet of daarmee vertroud is nie. Akronieme, jargon en kantoorterminologie sal jou kliënte verkeerd ingelig, gefrustreerd en onvoorbereid laat voel. Die lekkerste plek vir die vervaardiging van 'n gebruikershandleiding is om 'n balans te vind tussen om nie te skryf asof jou verbruikers kinders is nie (tensy dit natuurlik is!) en om hulle die ekstra hulp te gee wat hulle nodig het om heeltemal te verstaan hoe om die produk te gebruik, in eenvoudige taal. - Eenvoud
Om 'n gebruikershandboek te skryf, vereis om dinge eenvoudig te hou. Hierdie konsep moet in beide die inhoud en die ontwerp weerspieël word. As jy jou dokumentasie oorvul met ingewikkelde prente en lang teksgedeeltes, sal dit te gesofistikeerd en moeilik om te verstaan voorkom. Hierdie soort gebruikershandleiding sal waarskynlik jou gebruiker intimideer en daartoe lei dat hulle jou hulplyn bel eerder as om hul probleem op hul eie te probeer uitvind. - Beeldmateriaal
Die stellig "Wys, moenie vertel nie" is 'n hoeksteen van die skryf van gebruikershandleidings. Geannoteerde skermkiekies, flieks en ander visuele inhoud is uiters nuttig om konsepte te verstaan. Dit is dikwels baie nuttiger om iets in aksie te sien as om daaroor te lees. Beeldmateriaal breek nie net lang teksgedeeltes op nie, maar dit verminder ook die hoeveelheid teks in gebruikershandleidings wat skrikwekkend kan wees. Dit is bewys dat mense visuele inligting 7% vinniger behou as wat hulle geskrewe inligting doen. In 'n Techsmith-studie is dit ook getoon dat 67% van mense take meer effektief uitgevoer het wanneer hulle instruksies gegee het wat geannoteerde skermkiekies ingesluit het eerder as woorde alleen om inligting oor te dra. - Fokus op die probleem wat opgelos moet word
Dit is heel waarskynlik dat iemand jou produk gekoop het om 'n probleem aan te spreek. Dit is noodsaaklik om op hierdie kwessie gefokus te bly wanneer die gebruikershandleiding opgestel word wat by die produk ingesluit sal word. In plaas daarvan om al die kenmerke wat jou produk bied of die intrigerende ontwerpelemente wat jy ingesluit het op te noem en te bespreek, lig jou gebruikers daaroor in op 'n manier wat die gebruik van die produk vergemaklik. Plaas die probleem wat opgelos word in die konteks van jou produk se kenmerke en voordele wanneer jy dit beskryf. - Logiese vloei en hiërargie
Om dit vir die gebruiker duidelik te maak wat hulle uit elke afdeling van jou gebruikershandleiding sal leer, gebruik opskrifte en subopskrifte wat 'n duidelike hiërargiese struktuur volg. Om jou kliënte moeiteloos te lei deur alles wat hulle van begin tot einde moet weet, moet die hiërargie wat jy kies 'n logiese vloei volg. Maak seker jy begin met die grondbeginsels en inkorporeer 'n logiese vordering na jou produk se meer gesofistikeerde kenmerke. - Inhoud lys
Jou gebruikersgids sal baie nuttig wees vir lesers as dit met 'n inhoudsopgawe begin. Sonder om deur baie bladsye met inligting te grawe wat nie verband hou met die huidige probleem waarmee hulle te kampe het nie, is dit 'n bekende benadering vir iemand om vinnig en maklik 'n dokument te verken. - Maak dit soekbaar
Selfs as jy dalk jou gebruikershandleidings uitdruk, is dit waarskynlik dat digitale dokumentasie jou hoofprioriteit sal wees. Dit is heel waarskynlik dat jou gebruikershandleidings die meeste in 'n digitale formaat gebruik sal word in 'n wêreld waar die meerderheid mense te alle tye 'n slimfoon by hulle het. Deur 'n soekbare kenmerk by jou digitale gebruikershandleidings te voeg, sal dit 'n heerlike gebruiksgemak bevorder vir gebruikers wat 'n probleem wil oplos deur toegang daartoe te verkry, soortgelyk aan hoe 'n inhoudsopgawe dien om gebruikers na die regte plek in 'n gedrukte dokument te lei. - Toeganklikheid
Dit is moontlik dat sommige van die mense wat jou gebruikershandleiding benodig kan baat vind by ekstra bystand om te verseker dat dit behoorlik funksioneer. Ongeag of dit deur die wet vereis word, is toeganklikheidvereistes oor die algemeen goeie praktyk. Die handhawing van toeganklikheidvereistes in jou gebruikershandleidings is net uitstekende besigheidspraktyk. Die ontwerp van gebruikersgidse met inhoud wat toeganklik is vir gebruikers wat visuele, hoorbare of kognitiewe uitdagings kan hê, is van kardinale belang. - Goed ontwerp
Neem jou gehoor in ag wanneer jy jou gebruikersgidse skep. Hulle sal baie meer geneig wees om dit doeltreffend te gebruik as jy iets maak waarna hulle geniet om te kyk! Vermy die gebruik van lang teksblokke en voorsien baie wit spasie. Deur hierdie twee kenmerke te kombineer, kan dit verbruikers help om minder angswekkend te lyk en om enigiets nuuts te leer lyk opwindend eerder as dreigend. Die “wys, moenie vertel nie”-benadering wat ons vroeër beskryf het, geld ook hier. Vir beide gedrukte en digitale gebruikershandleidings is die byvoeging van beeldmateriaal en foto's by die teks 'n wonderlike alternatief. Vir digitale gebruikershandleidings bied video's en GIF's belangstelling en 'n nuttige element. As jou maatskappy 'n stylgids het, moet jou ontwerp dit volg; anders, as jy sonder een werk, is dit van kardinale belang om jou gebruikershandleiding konsekwent te hou. Die lettertipe en kleurskemas wat regdeur die vraestel gebruik word, en ideaal vir al jou gebruikersgidse, moet konsekwent wees. - Kommentaar van werklike kliënte of beta-toetsers
Jy sal nie kan vasstel of die gebruikersgidse wat jy voorberei het so suksesvol as moontlik is, totdat jy die terugvoer van die mense wat jou produk gaan gebruik, opgesoek en geluister het nie. Die gebruikersgidse wat jy vir jou produk ontwikkel, moet die probleme wat mense daarmee het, in ag neem. Jy kan dalk iets leer wat uiters duidelik lyk, maar die kans is baie groter dat jy iets sal leer wat jou sal help om die behoeftes van die kliënte wat jy probeer bereik, te verstaan.
Hoe skryf ek 'n gebruikershandleiding?
Om 'n gebruikershandleiding te maak is 'n deurslaggewende taak wat 'n groot impak kan hê op beide jou maatskappy en die verbruikers wat jy wil bedien. Ons het die proses van die ontwikkeling van 'n gebruikershandleiding vereenvoudig sodat jy maklik kan volg, want dit kan oorweldigend wees.
- Identifiseer die gebruikers
Om die ontvanger van jou kommunikasie te vind is 'n noodsaaklike eerste stap, net soos met enige ander kommunikasie wat jy genereer. Jou gebruikershandleiding se beoogde gehoor sal jou help om te besluit oor kwessies soos die toon, die vlak van detail om te verskaf en hoe om die inhoud te lewer. Die skryf van 'n gebruikersgids vir die eindgebruiker van jou produk is aansienlik anders as om een vir 'n tegniese ingenieur te skryf. Die heel eerste stap is om jou gehoor te bepaal. - Fokus op die probleem
Gebruikershandleidings word gemaak om te help met probleemoplossing of om iemand te onderrig oor hoe om iets nuuts te doen. Jy moet presies bepaal wat jou gebruikershandleiding bedoel is om te doen en seker maak dat jy daardie fokus behou.
Dit kan aanloklik wees om die onderwerp te verbreed en talle kenmerke of toepassings vir jou produk te bespreek. Dit kan gebruikers frustreer en lei tot oproepe na u kliëntedienslyn deur die opregte antwoord wat hulle benodig, te vertroebel.
As jou kliënt 'n verbruiker is wat leer hoe om die produk te gebruik of 'n tegnikus wat dit moet regmaak, konsentreer op die presiese oplossing wat hulle benodig. - Gebruik 'n opeenvolgende benadering
Jou gebruikershandleiding se instruksies moet uiteengesit word in die opeenvolgende volgorde wat nodig is om die werk voorhande te voltooi. Lys elke stap om te begin. Doen dan 'n poging om die opdrag te doen terwyl jy by die presiese stappe hou wat jy in die gegewe volgorde uiteengesit het. Soos jy deur jou oorspronklike lys gaan, is dit moontlik, miskien selfs waarskynlik, dat jy enige s sal vindtages wat ontbreek. Daarbenewens kan jy dalk vind dat iets wat jy eens geglo het 'n enkele taak is, eintlik in verskeie aktiwiteite verdeel moet word ter wille van duidelikheid.
Maak seker dat jy 'n duidelike uitkoms gespesifiseer het vir elke opeenvolgende stap wat jy toegeken het voordat jy aanbeweeg na die volgende fase van die skryf van 'n gebruikersgids. Voordat u na die volgende vlak beweeg, moet die lesers heeltemal duidelik wees oor wat hulle wil bereik en hoe dit moet lyk. - Kaart gebruiker reis
Om te verstaan hoe jou verbruikers beplan om jou produk te gebruik en dit vir hulle maklik te maak om dit te doen, is die doelwitte van die vervaardiging van 'n gebruikersgids. Jy moet die moeite doen om die probleem te begryp wat die verbruiker probeer oplos of die doelwit wat hulle probeer bereik deur jou oplossing te gebruik, asook hoe hulle met jou besigheid omgaan. U kan die stappe beplan wat nodig is om die kliënt deur die proses te lei deur hierdie besonderhede te gebruik om hul reis van probleem tot oplossing te visualiseer. - Kies 'n sjabloon
Die taak om gebruikershandleidings te skryf en te ontwikkel kan baie eenvoudiger gemaak word as wat jy sou verwag deur 'n reeks sjablone te skep. Jou prosedure kan vaartbelyn wees, en konsekwentheid sal 'n baie meer realistiese doelwit word.
Benewens die definisie van besonderhede soos lettertipes (tipe en grootte), kontrasvereistes en kleurskemas, moet jy ook die volgende in jou gebruikershandleidingsjabloon insluit:- Area toegeken vir 'n bekendstelling
- Afsonderlike onderafdelings en afdelings
- Jou gekose formaat om 'n reeks aksies oor te dra
- Waarskuwingsaantekeninge en waarskuwings
- Area toegeken vir 'n gevolgtrekking
- Skryf eenvoudige en maklik om te volg inhoud
Jou gebruikershandleiding se materiaal moet so eenvoudig en maklik om te verstaan as moontlik wees. Dit is belangrik om na te dink oor en die formaat en inhoud te ontleed vir duidelikheid en gerief.
Maak seker dat elke fase van die proses net een taak uiteensit en so duidelik en kort 'n taal as moontlik gebruik. Maak seker dat jy jou teks behoorlik wysig totdat jy 'n gebruikershandleiding het wat net die inligting bevat wat werklik nodig is. - Benader elke gebruiker soos 'n beginner
Aanvaar dat die leser van jou gebruikershandleiding geen voorafkennis van jou produk het wanneer dit geskep word nie. Skryf asof jy met 'n leek praat.
Enige gebruik van jargon of tegniese taal moet vermy word. Natuurlik sal daar tye wees wanneer dit vermy moet word, maar dit moet die absolute uitsondering wees. - Toets die produk se instruksies met beginner gebruikers
Die toetsfase van die skeppingsproses van die gebruikershandleiding is van kardinale belang. Die onderwerp van die eksperimentering het 'n beduidende impak op die uitkoms.
Toetsing moet ideaal gedoen word op mense wat nog nooit jou produk gebruik of die dokumentasie gesien het nie. Terwyl jy deur die gebruikershandleiding beweeg, kyk hoe hulle die proses voltooi en aanteken waar hulle vashaak. Dan moet die inligting behoorlik opgedateer word.
Slegs die hulp van die gebruikershandleiding behoort nodig te wees vir jou toetsers om die produk te gebruik. Hulle hoef nie vir meer hulp te vra nie. Die USSR-gids moet al die inligting hê wat hulle benodig. - Bou inhoud deur 'n praktiese benadering te gebruik
Alle pogings moet aangewend word om konkrete examplees en gedetailleerde beskrywings van enige uitkomste wat gebruikers mag ervaar nadat hulle elke stap in die gebruikershandleiding gevolg het. Die gebruiker moet bewus wees van enige terugvoer wat hulle van die produk mag kry, sowel as enige potensiële besienswaardighede of geluide wat hulle langs die pad mag teëkom. - Verduidelik simbole, ikone en kodes vroegtydig
Jy sal dalk ikone, simbole of kodes moet gebruik terwyl jy 'n gebruikershandleiding skryf om te help om die nodige instruksies te verskaf. Om lesersverwarring of frustrasie te voorkom, is dit noodsaaklik om dit so vroeg as moontlik in jou gebruikershandleiding te identifiseer.
Gebruikershandleiding Gereelde Vrae
Wat presies is gebruikershandleidings?
Gebruikersdokumentasie is inligting wat in die vorm van gebruikershandleidings of gebruikersgidse verskaf word en is bedoel om eindgebruikers te help om suksesvol met 'n produk te kommunikeer.
- Watter soort gebruikersdokumentasie is daar?
Fisiese dokumentasie, soos boekies of handleidings, is tradisioneel gebruik om gebruikersdokumentasie aan te bied. Deesdae word gebruikershandleidings meer gereeld digitaal vervaardig en versprei. - Wat is vervat in gebruikershandleidings?
'n Instruksiehandleiding of gebruikersgids gebruik goeie ontwerp, duidelike skryfwerk en 'n probleemoplossingsfokus. Ek moet 'n inhoudsopgawe hê, 'n logiese hiërargie en vloei nakom, en inhoud aanbied wat toeganklik is. Daarbenewens sal 'n goeie gebruikershandleiding deursoekbaar wees en rekening hou met gebruikers t.o.vviews. - Hoe word 'n gebruikersdokument gemaak?
Eenvoudige stappe kan gebruik word om gebruikershandleidings te ontwikkel. Die gebruikersgids se doelwitte moet eers bepaal word, en 'n strategie moet ontwikkel word om die bereiking daarvan moontlik te maak. Die gebruikershandleiding moet getoets en opgedateer word soos nodig voordat dit gepubliseer word. Ten slotte is dit belangrik om die gebruikershandleiding bygewerk te hou, deur veranderinge aan te bring soos nuwe opdaterings of uitgawes bygevoeg word.