Gratis stap vir stap instruksies 
As jy `n produk het wat baie verskillende take of subtake kan verrig, moet jy `n taakontleding vir elke taak uitvoer. Byvoorbeeld: in `n motor kan jy jou toeter toeter, jou vasgord en jou hoofligte aan of af skakel. Skep `n posontleding vir elk van hierdie, indien nodig. 
Vir `n produk se gebruikershandleiding om effektief te wees, moet dit geskryf word in ooreenstemming met die etikette wat direk op die produk aangebring is. Voordat u die gebruikershandleiding skryf, maak seker dat u toestel amptelike lisensies het om te verkoop. 
Nog `n manier om jou handleiding te stroomlyn is om twee kolomme te gebruik, een regs met teks en die ander net links van die teks, met kolpunte, syfers of klein ikone, soos waarskuwingstekens of rooi uitroeptekens. Die handleiding kan hoofsaaklik bestaan uit prente met `n bietjie teks onder elke prent om die toestel te verduidelik, of dit kan hoofsaaklik teks wees met slegs `n paar meegaande prente. Jy kan ook `n vloeidiagram gebruik om die gebruiker te lei. Dink aan jou produk en hoe elke metode jou kan help om jou handleiding te skryf. Vermy egter om verskillende uitlegte binne `n handleiding te meng. Kies een en hou daarby. 
Byvoorbeeld, `n algemene waarskuwing vir `n elektriese toestel kan wees om dit nie tydens reën te gebruik nie. `n Spesifieke leidraad kan wees om seker te maak dat beide jou hande en die toestel droog is voordat jy die toestel inprop. Verskaf beelde (soos `n skedel en gekruiste bene) of teks in `n ander kleur (soos rooi teks) om die waarskuwing van die res van die instruksies in die handleiding te onderskei en gebruikers se aandag daarop te vestig. 
`n Onderdelelys Uitpakinstruksies Installasie waarskuwings Gevolge van `n verkeerde installasie Wie om te bel in geval van installasie probleme 
Aan die einde van hierdie hoofstuk moet gebruikers verwys word na die probleemoplossingshoofstuk om probleme op te los wat nie vinnig verduidelik kan word nie. Plaas beelde waar nodig. Sommige stappe word die beste met beide prente en woorde verduidelik. Dink daaraan om foto`s of illustrasies in jou handleiding te gebruik. In hierdie deel, soos in enige deel, moet jy relevante veiligheidswaarskuwings oor onbehoorlike gebruik of werking insluit. Jy kan byvoorbeeld kettingsaaggebruikers waarsku om nie alkohol te drink of die kettingsaag te gebruik terwyl hulle sekere medikasie neem nie. As jy dink dit sal gebruikers baat, oorweeg dit om skakels na aanlynvideo`s in te sluit wat die korrekte gebruik en werking van die toestel demonstreer. Jy kan hierdie video`s óf aan die begin van hierdie afdeling insluit, óf (in die geval van video`s wat slegs een stap illustreer) aan die einde van elke stap. 
As jy verwag dat die gebruiker die opsommingsblad moet verwyder of gereeld daarna moet verwys, kan jy dit op `n verwyderbare gelamineerde kaart of dik karton druk om dit vir die gebruiker makliker te maak om te dra en verwys na. Alternatiewelik kan jy `n opsomming direk op die produk plaas vir vinnige en maklike verwysing vir die gebruiker. 
As daar sekere instandhoudingstake is wat slegs deur `n gesertifiseerde tegnikus uitgevoer kan word, verdeel die instandhoudingsgedeelte van die handleiding in twee dele. 
`Bêre die produk in `n koel, droë plek. Onbehoorlike berging kan die leeftyd van jou produk verkort as gevolg van vogopbou.` `Moenie die produk aan hitte blootstel nie en moet dit nie by temperature bo 50 grade Celsius berg nie. As jy dit doen, kan dit lei tot ontsteking.` 
Byvoorbeeld, as daar verskeie probleme is met die rekenaar wat `n blou skerm vertoon, groepeer dit onder `n subopskrif, soos "Algemene skermprobleme". U moet ook `n kliëntediensfoonnommer en/of e-pos in hierdie afdeling insluit. 
Byvoorbeeld, in plaas daarvan om beide "aan/af skakelaar" en "aan/af knoppie" in jou handleiding te gebruik, kies een van die twee terme en hou daarby. 
Probeer die Hemingway-toepassing (www.hemmingway-app.com) om passiewe gedeeltes in jou skryfwerk te herken. Bestudeer hierdie twee voorbeeldsinne -- die eerste is aktief en die tweede passief: Jy moet die pakkie stadig en versigtig oopmaak. Die pakkie moet stadig en versigtig oopgemaak word. 
Byvoorbeeld, as die skerm blou word en begin flikker, moenie die stap begin met "Die skerm sal flikker en blou word nie.` Probeer: `Druk en hou die huissleutel in. Die skerm sal flikker en blou word.` 
Probeer oor die algemeen om jargon en tegniese taal te vermy. Om effektief te wees vir die wydste moontlike gebruikersbasis, probeer om op `n vlak van sesde tot sewende graad te skryf. 
As verskeie taalgroepe in jou gehoor verteenwoordig word, sluit asseblief vertalings van die gebruikershandleiding in elke relevante taal in. Die vertaler moet vertroud wees met die produk aangesien daar ander woorde in die teikentaal kan wees vir spesifieke terme wat nie woord-vir-woord vertalings is nie. 
As `n tree te lank begin word, breek dit af in kleiner stappe. Dit sal nie die woordtelling verlaag nie, maar die reëlbreuke sal dit makliker maak om te lees. 
Passiewe stem Onduidelike of verwarrende taal toegedraaide sinstruktuur Te lang paragrawe
Die skryf van 'n gebruikersgids
Inhoud
Sagteware, rekenaars, speletjies en toestelle vereis gebruikershandleidings; gidse wat verduidelik hoe om die produk te gebruik (en hoe nie). `n Gebruikershandleiding is `n formele dokument met `n spesifieke struktuur, en moet geskryf word deur iemand wat die produk deur en deur ken, soos `n tegniese skrywer of die produkontwerper. Om `n effektiewe gebruikershandleiding te skryf vereis dat jy weet wie die produk gaan gebruik, en dat jy die handleiding skryf met hierdie gebruikers in gedagte. Hou jou skryfwerk duidelik, presies en eenvoudig om `n moeitevrye gebruikerservaring te verseker.
Trappe
Deel 1 van 4: Beplan jou gebruikersgids
1. Doen `n gebruikersontleding. Die gebruikersgids moet vir die gebruikers geskryf word -- diegene wat jou produk of diens sal koop en die gebruikersgids sal lees. `n Gebruikersontleding sal jou vertel wie jou hoof- of teikengehoor sal wees en sal jou lei in die skryf van die teks.
- Praat met mense wat jou toestel sal gebruik. Voorsien toetsgebruikers van prototipes van die toestel en `n konsep van die gebruikershandleiding onder gekontroleerde toestande. Vra hierdie toetsgebruikers vir terugvoer oor dinge wat nie duidelik of verwarrend in die gebruikersgids is nie en maak veranderinge aan jou gebruikersgids op grond van hierdie terugvoer.
- Jy kan nooit jou hele gehoor tevrede stel nie; skryf die handleiding wat aangepas is vir die teikengehoor of die grootste gehoor.
- Dink aan ouderdom, gesondheid (het hulle enige siektes, leergestremdhede of gestremdhede??) en die vlak van opvoeding van die publiek, om die beste benadering vir die skryf van die gebruikershandleiding te bepaal.
2. Koördineer die ontwerp van die gebruikershandleiding. As jy deel was van die span wat gehelp het om die toestel of produk te ontwerp en te ontwikkel, kan dit moeilik wees om objektief na die produk te kyk om te verduidelik hoe dit werk. Jy moet dus die advies van `n skrywer (verkieslik iemand met ondervinding in die skryf van instruksies) en `n grafiese ontwerper inwin om jou te help om die gebruikershandleiding voor te berei. Jy kan hierdie mense kies deur `n eksterne konsultasie of van jou eie maatskappy of organisasie.
3. Doen `n posontleding. `n Posontleding is die proses om die stappe wat nodig is om die toestel te gebruik, te identifiseer en te organiseer. `n Deeglike werkontleding identifiseer die materiaal en toerusting (soos batterye, dwelms of ander produkte wat deur die gebruiker verskaf word) wat vir elke stap benodig word, sowel as die aksies, foute en probleemoplossingsadvies wat elke stap mag vereis.
4. Maak seker dat jou produk aan etikettering en bemarkingsmagtigingsvereistes voldoen. Hierdie vereistes verseker dat produkte vervaardig word met die gebruiker se veiligheid in gedagte, en dat die gebruiker se blootstelling aan gevaarlike toestande, soos bestraling en elektrokusie, beperk is. Advertensies moet die doel en basiese bedryfsriglyne van `n produk duidelik aandui, en jy moet hierdie hulpbronne gebruik wanneer jy jou gebruikersgids skryf.
5. Besluit op die uitleg van jou handleiding. Daar is verskeie belangrike maniere waarop jy jou handleiding kan stroomlyn. Jy moet `n vet opskrif aan die begin van elke afdeling met elke woord in hoofletters plaas. Byvoorbeeld, "Stel jou toestel op," "Beheer jou toestel" en "Foutspoor" kan almal vet afdelingopskrifte wees.
Deel 2 van 4: Inbedding van noodsaaklike inligting
1. Organiseer die handleiding logies. Die handleiding moet so gestruktureer wees dat die gebruiker die meeste voordeel daaruit sal trek. Verdeel die handleiding in hoofstukke of afdelings wat sin maak vir die gebruik van die produk, en sluit `n inhoudsopgawe voor in die handleiding in sodat elke afdeling vinnig gevind kan word.
- `n Inhoudsopgawe is veral nodig vir langer gidse.
- ’n Woordelys of indeks is nodig as daar baie terme is om te verduidelik wat jou gehoor dalk nie ken nie. `n Woordelys word egter nie aanbeveel nie; die beste keuse is om verwarrende terme in die teks van die handleiding self te verduidelik. As jy kies om `n woordelys in te sluit, plaas dit voor in die handleiding, net na die inhoudsopgawe.
- `n Lys van tabelle of figure is slegs nodig as daar meer as `n paar tabelle of figure in die handleiding is.
- `n Bylaag word benodig vir dinge wat verduidelik moet word, maar nie elders in die handleiding verduidelik kan word nie, aangesien dit vloei en fokus sal ontwrig.
2. Sluit die nodige waarskuwings in. Die algemene waarskuwings of voorsorginligting moet inligting verskaf oor potensiële gevare wat mag ontstaan uit onbehoorlike gebruik van die produk, insluitend dood of ernstige besering. Hierdie waarskuwings moet heel voor in die handleiding geplaas word, na die voorblad, sodat die gebruiker dit eerste sien. Spesifieke waarskuwings moet ook in die teks van die handleiding ingesluit word net na of net voor `n potensieel gevaarlike stap voorgestel word.
3. Beskryf die toestel. Jou beskrywing moet beide `n geskrewe verduideliking van die doel van die toestel en `n klein grafiese voorstelling van hoe die toestel lyk insluit. Die illustrasie moet alle skakelaars, knoppies en aanhegbare dele wat in die toestel vervat is, byskrifte en benoem.
4. Verskaf installasie-instruksies. Die installasie-afdeling moet basiese inligting bevat oor hoe om voor te berei om die produk of toestel te gebruik. As die toestel nie deur `n tuisgebruiker gebou of opgestel kan word nie, meld dit duidelik in `n vet opskrif boaan die installasie-afdeling. Jy moet ook die volgende insluit:
5. Verskaf operasie inligting. Hierdie afdeling is die belangrikste deel van die gebruikershandleiding en moet konkrete, gedetailleerde inligting verskaf oor hoe om die toestel te gebruik. Begin met die basiese voorbereiding voordat jy die toestel gebruik, soos om die prop in te steek of jou hande te was. Gaan voort met logiese, genommerde stappe wat beskryf hoe om die toestel te gebruik, sowel as terugvoer (byvoorbeeld, "Jy hoor `n klik...`) wat die gebruiker kan verwag wanneer die toestel korrek gebruik word.
6. Voeg `n opsomming van die produk aan die einde by. Die opsomming moet aan die einde van die handleiding kom, net voor die indeks, om die basiese stappe van werking te gee. Dit moet `n vereenvoudigde, gestroopte weergawe van die operasionele inligting wees, en moet nie een bladsy oorskry nie. Som op hoe om die toestel of produk te gebruik. Sluit basiese waarskuwings, genommerde stappe in wat verduidelik hoe om die produk te gebruik, en telefoonnommers of e-posadresse wat gebruikers aanstuur om te help.
Deel 3 van 4: Beskrywing van die produkinstandhouding
1. Verduidelik hoe om die toestel skoon te maak. As jou toestel of produk skoongemaak moet word, verduidelik hoe om dit te doen. Lys die vereiste skoonmaakmiddels. Vertel die leser hoe gereeld om skoon te maak. Sluit dan, soos in enige ander deel van die handleiding, genommerde stap-vir-stap instruksies in oor hoe om skoon te maak.
- Indien skoonmaak die demontage van die produk, of die verwydering van `n sekere deel of dele vereis, dui asseblief aan hoe om die produk uitmekaar te haal.
- Gee `n waarskuwing oor die resultate van die versuim om die toestel skoon te maak. Byvoorbeeld, jy kan sê: "As die toestel nie skoongemaak word nie, sal die werkverrigting minder as optimaal wees.`
2. Tel die gebruiker hoe om basiese instandhouding uit te voer. Indien die produk of toestel deur die gebruiker gediens kan word om prestasieprobleme reg te stel, verskaf genommerde instruksies oor hoe om dit deur die gebruiker te doen. Byvoorbeeld: as die batterye na elke 300 uur se gebruik vervang moet word, verskaf instruksies oor hoe om te kyk of die batterye vervang moet word, hoe om die gebruikte batterye te verwyder en hoe om die nuwe batterye in te sit.
3. Bespreek bergingsopsies. Die handleiding moet, indien nodig, verduidelik hoe om die produk of toestel korrek te berg. jy moet ook inligting insluit oor hoekom berging nodig is, en wat die gevolge van verkeerde berging is. Byvoorbeeld, jy kan skryf:
4. Verskaf inligting oor probleemoplossing. Jy kan hierdie afdeling organiseer as `n lys van algemene probleme en hul oplossings. Groepeer soortgelyke probleme onder `n logiese opskrif. Op hierdie manier kan gebruikers vinnig spesifieke probleme vind.
Deel 4 van 4: Skryf `n leesbare gids
1. Lees ander gebruikersgidse. Voordat u `n handleiding vir u eie produk skryf, kyk na ander effektiewe gebruikershandleidings. Gee aandag aan die struktuur, keuse van woorde en sinstruktuur. Groot handelsmerke soos Apple, Google en Microsoft produseer sterk, doeltreffende gebruikersgidse wat jou kan help om `n deurdagte geskrewe gebruikersgids te skep.
- Moenie net lees nie almal gebruikershandleidings. Lees die handleidings van soortgelyke produkte wat jy verkoop. Byvoorbeeld: as jy babaprodukte verkoop, lees babahandleidings, nie tegniese nie.
2. Kies jou standaarde. Standaardisering van spelling, woordkeuse en bewoording sal die gebruikersgids meer gebruikersvriendelik maak. Die Chicago Manual of Style en die Microsoft Manual of Style kan ook nuttige stylgidse wees wanneer u u eienaarshandleiding skryf; kyk na albei om te sien of een reg is vir jou handleiding.
3. Gebruik die aktiewe stem. Die aktiewe stem is `n manier van skryf wat dinge vanuit die gebruiker se perspektief verduidelik. Dit is makliker om te verstaan as die alternatief, die passiewe stem, waarin die onderwerp ongedefinieerd is.
4. Skryf genommerde instruksies. Numeries-geordende instruksies help die leser om beter te fokus op die proses van gebruik, koppeling of bou van die betrokke produk. In plaas daarvan om `n lang, breedvoerige paragraaf of `n reeks ongenommerde paragrawe te skryf, skryf jou gebruikersgids met eenvoudige, eksplisiete stappe, elk duidelik genommer.
5. Begin elke stap met `n imperatief. `n Imperatief is `n aksie-georiënteerde werkwoord. Deur elke stap met `n werkwoord te begin, gee jy die leser `n wenk oor die aksie wat nodig is om die stap te voltooi. Byvoorbeeld, afhangende van die produk waaroor jy skryf, kan jy jou stappe begin met `n opdrag soos "Verbind", "Bevestig" of "Skuif.". Moet egter nie jou stappe begin met `n reaksie van die stelsel nie.
6. Besluit watter woordeskat jy gaan gebruik. As jy ’n gebruikershandleiding vir ’n jojo skryf, sal jou gehoor hoofsaaklik uit jong kinders bestaan. Gebruik eenvoudige woorde en woordeskat om te verduidelik hoe die jojo werk. As jy `n skandeerelektronmikroskoophandleiding skryf, sal jou gehoor hoogs opgeleide wetenskaplikes wees wat baie gedetailleerde inligting kan verstaan, so moenie wegskram om gespesialiseerde woordeskat of genuanseerde verduidelikings te gebruik nie.
7. Wanneer u `n produk oorsee stuur, maak seker dat u vertalings akkuraat is. Huur `n vertaler om jou gebruikershandleiding te vertaal in die moedertaal van die land waarheen jy jou produk stuur. Jy kan ook `n aanlyn vertaalhulpmiddel gebruik, maar vra `n moedertaalspreker om die vertaling te lees en na te gaan vir foute.
8. Skryf in kort sinne. In plaas van `n paar lang paragrawe, gebruik baie kort paragrawe. Soek logiese breuke in elke afdeling en verteer nuttige inligting in een- of tweesinstukke. Dieselfde geld op sinvlak. Hou jou sinne kort en eenvoudig, in plaas van lank en breedvoerig.
9. Gaan die handleiding na vir foute. `n Handleiding kan geloofwaardigheid verloor as gevolg van grammatika en spelfoute. Laat `n kollega of tegniese skrywer ook die handleiding redigeer en proeflees. Benewens spelling en grammatika, moet `n proefleser aandag gee aan die volgende:
Wenke
- Mense leer op verskillende maniere; Indien moontlik en toepaslik, sluit visuele hulpmiddels of skakels na aanlynvideo`s in die handleiding in om visueel georiënteerde lesers te akkommodeer.
Artikels oor die onderwerp "Die skryf van 'n gebruikersgids"
Оцените, пожалуйста статью
Gewilde
