Inhalt

• Ze trëppelen
• Deel 1 vu 4: Plangt Äre Besëtzerhandbuch
• Deel 2 vu 4: Embed essentiell Informatioun
• Deel 3 vu 4: Beschreiwung vum Produkt Ënnerhalt
• Deel 4 vu 4: Schreift e liesbaren Handbuch
• Tipps

Software, Computeren, Spiller an Apparater erfuerderen Benotzermanualen; Guiden erkläre wéi Dir de Produit benotzt (a wéi net). E Benotzerhandbuch ass e formellt Dokument mat enger spezifescher Struktur a muss vun engem geschriwwe ginn deen de Produit vu bannen weess, wéi en technesche Schrëftsteller oder de Produktdesigner. Eng effektiv Handbuch ze schreiwen erfuerdert datt Dir wësst wien de Produkt benotzt an datt Dir d'Handbuch mat dëse Benotzer am Kapp schreift. Halt Äert Schreiwen kloer, präzis an einfach fir eng Iergerfreie Benotzererfarung ze garantéieren.

Ze trëppelen

Deel 1 vu 4: Plangt Äre Besëtzerhandbuch

1. Maacht eng Benotzeranalyse. D'Benotzerhandbuch soll fir d'Benotzer geschriwwe ginn - déi déi Äre Produkt oder Service kafen an d'Benotzerhandbuch liesen. Eng Benotzeranalyse wäert Iech soen wien Är Haapt- oder Zielpublikum wäert sinn a féiert Iech duerch d'Schreiwe vum Text.
   • Schwätzt mat Leit déi Ären Apparat benotze wäerten. Bitt Test Benotzer Prototypen vum Apparat a Benotzerhandbuch ënner kontrolléierte Konditiounen. Frot dës Testbenutzer fir Feedback iwwer Saachen déi onkloer oder duerchernee sinn am Benotzerguide a maacht Ännerungen an Ärem Benotzerguide baséiert op dësem Feedback.
   • Dir kënnt Äert ganz Publikum ni zefridden stellen; schreift d'Handbuch ugepasst op d'Zilpublikum oder de gréisste Publikum.
   • Betruecht Alter, Gesondheet (hu se Krankheeten, Léierstéirungen oder Behënnerungen?) An den Niveau vun der Erzéiung vum Publikum fir déi bescht Approche fir d'Benotzerhandbuch ze schreiwen.
2. Koordinéiert den Design vum Handbuch. Wann Dir en Deel vum Team sidd, dat gehollef huet den Apparat oder Produkt z'entwéckelen an z'entwéckelen, kann et schwéier sinn en objektiv ze kucken op d'Produkt ze erkläre wéi et funktionnéiert. Dir sollt also de Rot vun engem Schrëftsteller sichen (am léifsten een mat Erfarungsschreiweinstruktiounen) an engem Grafikdesigner fir Iech ze hëllefen d'Benotzerhandbuch virzebereeden. Dir kënnt dës Leit wielen duerch eng extern Berodung oder vun Ärer eegener Firma oder Organisatioun.
3. Maacht eng Taskanalyse. Jobanalyse ass de Prozess fir d'Schrëtt z'identifizéieren an z'organiséieren déi néideg sinn fir den Apparat ze benotzen. Eng grëndlech Jobanalyse identifizéiert d'Materialien an d'Ausrüstung (wéi Batterien, Medikamenter oder aner benotzte Produkter geliwwert) fir all Schrëtt erfuerderlech, souwéi d'Aktiounen, d'Feeler an d'Problematikberodung déi all Schrëtt erfuerderen.
   • Wann Dir e Produkt hutt dat vill verschidden Aufgaben oder Ënnertäschen ausféiere kann, musst Dir eng Taskanalyse fir all Aufgab maachen. Zum Beispill: an engem Auto kënnt Dir zocken, strappt Iech selwer a schalt Är Luuchten un oder aus. Maacht eng Jobanalyse fir all dës, wann néideg.
4. Gitt sécher datt Äert Produkt den Ufuerderunge fir d'Etikettéierung a Marketing Autorisatioun entsprécht. Dës Ufuerderunge garantéieren datt Produkter mat der Sécherheet vum Benotzer hiergestallt ginn an datt de Benotzer seng Expositioun u geféierleche Bedéngungen, wéi Stralung an Elektrocutioun, limitéiert ass. Annoncen solle kloer den Zweck a Basis Operatiounsrichtlinne vun engem Produkt uginn, an Dir sollt dës Ressource benotze wann Dir Äre Besëtzerhandbuch schreift.
   • Fir e Benotzerhandbuch fir e Produkt effektiv ze sinn, muss et geméiss den Etikette geschriwwe ginn, déi direkt op de Produit befestegt sinn.
   • Gitt sécher datt Ären Apparat offiziell ze verkafen ass ier Dir de Benotzerhandbuch schreift.
5. Entscheed Iech iwwer de Layout vun Ärem Handbuch. Et gi verschidde wichteg Weeër fir Äert Handbuch ze vereinfachen. Dir musst eng fett Iwwerschrëft am Ufank vun all Sektioun mat all Wuert a grousse Buschtawe setzen. Zum Beispill, "Setzt Ären Apparat op", "Operéiert Ären Apparat", an "Troubleshoot" kënnen all fett Rubrik Rubriken sinn.
   • Eng aner Manéier fir Äre Guide ze streamlinéieren ass zwou Kolonnen ze benotzen, eng riets mam Text an déi aner just lénks vum Text, mat Kugelen, Zuelen oder kleng Ikonen, wéi Warnzeechen oder rout Ausruffzeechen.
   • De Handbuch kann haaptsächlech aus Biller bestoen mat engem Text ënner all Bild fir den Apparat z'erklären, oder et kann haaptsächlech Text mat nëmmen e puer begleitende Biller sinn. Dir kënnt och e Stroumdiagramm benotze fir de Benotzer ze leeden. Denkt un Äert Produkt a wéi all Methode Iech hëllefe kënnt Är Handbuch ze schreiwen. Allerdéngs vermeit verschidde Layouten an engem Handbuch ze vermëschen. Wielt een a bleift drun.

Deel 2 vu 4: Embed essentiell Informatioun

1. Organiséiert d'Handbuch logesch. D'Handbuch soll esou strukturéiert sinn datt de Benotzer am meeschte Benefice dovu kritt. Deelt de Handbuch a Kapitelen oder Sektiounen, déi sënnvoll sinn fir de Produit ze benotzen an enthält en Inhaltsverzeechnes op der Franséischt vum Handbuch, sou datt all Sektioun séier fonnt gëtt.
   • En Inhaltsverzeechnes ass besonnesch noutwendeg fir méi laang Handbüroen.
   • E Glossar oder Index ass gebraucht wann et vill Begrëffer gëtt fir z'erklären datt Äert Publikum net kannt ass. Wéi och ëmmer, e Lexikon gëtt net recommandéiert; déi bescht Wiel ass ze verwiessele Begrëffer am Text vum Handbuch selwer z'erklären. Wann Dir wielt e Glossar mat anzebezéien, placéiert se op der viischter Säit vum Handbuch, direkt no der Inhaltsverzeechnes.
   • Eng Lëscht vun Dëscher oder Figuren ass nëmmen néideg wann et méi wéi e puer Dëscher oder Figuren am Handbuch sinn.
   • En Appendix ass gebraucht fir Saachen déi erkläert musse ginn awer net anzwousch anescht an der Handbuch erkläert ginn, well et de Stroum an de Fokus géif stéieren.
2. Ëmfaasst néideg Warnungen. Déi allgemeng Warnungen oder virsiichteg Informatioun soll Informatioun iwwer potenziell Geforen ubidden, déi duerch falsch Benotzung vum Produkt verursaacht ginn, inklusive Doud oder schwéier Verletzung. Dës Warnunge solle ganz vir am Handbuch plazéiert ginn, no der éischter Säit, sou datt de Benotzer se als éischt gesäit. Spezifesch Warnunge sollten och am Text vum Handbuch abegraff ginn just duerno oder just ier e potenziell geféierleche Schrëtt virgeschloe gëtt.
   • Zum Beispill eng allgemeng Warnung fir en elektrescht Apparat kéint et net benotzen wann et reent.
   • Eng spezifesch Instruktioun ka sécher sinn datt béid Är Hänn an den Apparat trocken sinn ier Dir de Gerät an de Steckdous stécht.
   • Gitt Biller (wéi e Schädel a Kräizbeen) oder Text vun enger anerer Faarf (wéi rouden Text) fir d'Warnung vun de Rescht vun de Richtungen an der IFU z'ënnerscheeden an d'Benotzer drop opmierksam ze maachen.
3. Beschreift den Apparat. Är Beschreiwung soll eng schrëftlech Erklärung vum Zweck vum Apparat enthalen an eng kleng grafesch Duerstellung vu wéi den Apparat ausgesäit. D'Figur soll all Schalter, Knäppercher an uschléissend Deeler aus dem Apparat enthalen a benennen.
4. Gitt Installatiounsinstruktiounen. D'Installatiounssektioun sollt Basisinformatiounen enthalen wéi Dir Iech virbereet fir de Produit oder den Apparat ze benotzen. Wann den Apparat net vun engem Heembenotzer gebaut oder opgeriicht ka ginn, da sot dat kloer an enger fett Iwwerschrëft uewen an der Installatiounssektioun. Dir sollt och déi folgend abegraff:
   • Eng Deeler Lëscht
   • Uweisungen auszepaken
   • Installatioun Warnungen
   • Konsequenze vu falscher Installatioun
   • Wien ze ruffen am Fall vu Schwieregkeete bei der Installatioun
5. Gitt Informatioun iwwer d'Operatioun. Dës Sektioun ass de wichtegsten Deel vum Benotzerhandbuch a soll konkret, detailléiert Informatioune liwweren wéi een den Apparat benotzt. Fänkt mat der Basis Virbereedung fir d'Benotzung vun der Eenheet un, wéi zum Beispill de Stroumschnouer anzepaken oder d'Hänn ze wäschen. Fuert weider mat logeschen, nummeréierte Schrëtt, déi beschreiwen, wéi een den Apparat benotzt, souwéi all Feedback (zum Beispill "Dir héiert e Klick ..."), deen de Benotzer kann erwaarden, wann en den Apparat richteg benotzt.
   • Um Enn vun dësem Kapitel sollten d'Benotzer an de Kapitel Troubleshooting bezeechent ginn fir Problemer ze léisen déi net séier erkläert kënne ginn.
   • Plaz Biller wou néideg. E puer Schrëtt ginn am beschten mat Biller a Wierder erkläert. Betruecht d'Benotzung vu Fotoen oder Illustratiounen an Ärem Handbuch.
   • An dëser Sektioun, wéi an all Sektioun, sollt Dir relevant Sécherheetswarnungen iwwer ongerecht Benotzung oder Operatioun enthalen. Zum Beispill, Dir kënnt Kettensaw Benotzer warnen net Alkohol ze drénken oder d'Mesaw ze benotzen wa se op verschidde Medikamenter sinn.
   • Wann Dir denkt datt d'Benotzer profitéiere wäerten, fannt Dir Links op online Videoe mat abegraff fir de richtege Gebrauch a Betrib vum Apparat ze weisen. Dir kënnt dës Videoen entweder am Ufank vun dëser Sektioun ophuelen, oder (am Fall vu Videoen déi nëmmen ee Schrëtt illustréieren) um Enn vun all Schrëtt.
6. Ëmfaasst e Resumé vum Produkt um Enn. De Resumé soll um Enn vum Handbuch erschéngen, just virum Index, fir Basisbetriebsschrëtt ze bidden. Dëst sollt eng vereinfacht, ofgerappt Versioun vun der operationeller Informatioun sinn, a sollt net méi wéi eng Säit sinn. Summéiert wéi den Apparat oder de Produkt soll benotzt ginn. Enthält Basis Alarmer, nummeréiert Schrëtt, déi erkläre wéi Dir de Produit benotzt, an Telefonsnummeren oder E-Mail Adressen déi d'Benotzer direkt hëllefen.
   • Wann Dir erwaart datt de Benotzer de Resuméblat dacks ewechhuelt oder bezitt, kënnt Dir et op eng eraushuelbar laminéiert Kaart oder déck Kartong drécken fir et méi einfach fir de Benotzer ze droen an ze referenzéieren.
   • Alternativ kënnt Dir e Resumé direkt op de Produit uwenden fir séier an einfach Referenz vum Benotzer.

Deel 3 vu 4: Beschreiwung vum Produkt Ënnerhalt

1. Erkläert wéi een den Apparat botzt. Wann Ären Apparat oder Produkt gebotzt gëtt, erkläert wéi Dir dëst maacht. Lëscht déi néideg Botzmëttelen. Sot de Lieser wéi dacks ze botzen. Dann, wéi an all aneren Deel vum Handbuch, enthält nummeréiert Schrëtt fir Schrëtt Instruktioune wéi een et botzt.
   • Wann d'Botzung de Produit ofmontéiert oder e bestëmmten Deel oder Deeler ofhuele muss, da gitt un wéi d'Produkt soll ofmontéiert ginn.
   • Gitt eng Warnung iwwer d'Resultater vum Feeler fir den Apparat ze botzen. Zum Beispill kënnt Dir soen: "Wann den Apparat net gebotzt gëtt, wäert d'Leeschtung manner wéi optimal sinn."
2. Zielt de Benotzer wéi en Basis Ënnerhalt mécht. Wann de Produit oder den Apparat benotzbar ass fir Leeschtungsprobleemer ze korrigéieren, gitt nummeréiert Instruktiounen wéi Dir dëst fir de Benotzer maacht. Zum Beispill, wann d'Batterien no all 300 Stonne Gebrauch mussen ersat ginn, gitt Instruktiounen wéi ze kontrolléieren ob d'Batterien ersat musse ginn, wéi déi doude Batterien ewechgeholl ginn a wéi déi nei installéiert ginn.
   • Wann et gewëssen Ënnerhalungsaufgaben gëtt, déi nëmme vun engem zertifizéierten Techniker ausgefouert kënne ginn, deelt den Ënnerhaltdeel vum Handbuch an zwee Deeler.
3. Diskutéieren Stockage Optiounen. Wann néideg, sollt d'Handbuch erkläre wéi een de Produit oder den Apparat richteg späichert. Dir sollt och Informatioune mat abauen firwat Stockage noutwendeg ass an d'Konsequenze vun enger falscher Lagerung. Zum Beispill: Dir kënnt schreiwen:
   • Späichert de Produkt an engem kalen, dréchenen Uert. Falsch Späichere kann d'Liewensdauer vun Ärem Produkt verkierzen wéinst Fiichtegkeet. "
   • "Maacht d'Produkt net ze hëtzen oder späichert et bei Temperaturen iwwer 50 Grad Celsius.Wann Dir et maacht, kann et zu Verbrennung féieren. "
4. Gitt Informatioun iwwer d'Probleemer. Dir kënnt dës Sektioun als Lëscht vu gemeinsame Probleemer an hir Léisunge organiséieren. Gruppéiert ähnlech Problemer ënner enger logescher Iwwerschrëft. Op dës Manéier kënnen d'Benotzer séier spezifesch Probleemer fannen.
   • Zum Beispill, wann et e puer Probleemer mam Computer gëtt deen e bloe Bildschierm weist, gruppéiere se ënner enger Ënnerkapsel, wéi zum Beispill "Allgemeng Bildschirmprobleemer".
   • Dir musst och eng Telefonsnummer an / oder E-Mail fir de Clientsdéngscht an dëser Rubrik enthalen.

Deel 4 vu 4: Schreift e liesbaren Handbuch

1. Liest aner Benotzerguiden. Ier Dir e Handbuch fir Äert eegent Produkt schreift, kuckt aner effektiv User Guiden. Opgepasst op d'Struktur, d'Wuertauswiel a Sazstruktur. Grouss Marken wéi Apple, Google a Microsoft produzéieren staark, effektiv User Guiden, déi Iech hëllefe kënnen e méi nodenklech geschriwwene Guide ze produzéieren.
   • Liest net nëmmen all Benotzerhandbicher. Liest d'Handbüroen fir ähnlech Produkter déi Dir verkaaft. Zum Beispill, wann Dir Babyprodukter verkaaft, liest Babyhandbüroen, net technesch.
2. Wielt Är Standarden. Standardiséiere vun Orthographie, Wuertwahl a Formuléierung wäert d'Benotzerhandbuch méi userfrëndlech maachen. De Chicago Manual of Style a Microsoft Manual of Style kënnen och hëllefräich Styl Guiden sinn wann Dir Äre Besëtzerhandbuch schreift; préift béid fir ze kucken ob ee richteg ass fir Äert Handbuch.
   • Zum Beispill, anstatt datt Dir "Power Switch" an "Power Button" an Ärem Handbuch benotzt, wielt ee vun deenen zwee Begrëffer a bleift drun.
3. Benotzt déi aktiv Stëmm. Déi aktiv Stëmm ass e Wee fir ze schreiwen, deen d'Saachen aus der Perspektiv vum Benotzer erkläert. Et ass méi einfach ze verstoen wéi d'Alternativ, déi passiv Stëmm, an där d'Thema ondefinéiert ass.
   • Probéiert d'Hemingway App (www.hemmingwayapp.com) fir passiv Passagen an Ärem Schreiwen z'identifizéieren.
   • Studéiert dës zwou Beispiller Sätz - déi éischt ass aktiv an déi zweet ass passiv:
     • Dir musst de Package lues a suergfälteg opmaachen.
     • De Package sollt lues a suergfälteg opgemaach ginn.
4. Schreift nummeréiert Instruktiounen. Numeresch bestallt Instruktioune hëllefen de Lieser besser ze konzentréieren op de Prozess vum Gebrauch, d'Verbindung oder de Bau vum betraffene Produkt. Amplaz e laangen, verbose Paragraf ze schreiwen oder eng Serie vun onnummeréierten Paragrafen, schreift Äre Benotzerguide mat einfachen, explizite Schrëtt, all kloer nummeréiert.
5. Fänkt all Schrëtt mat engem Imperativ un. En Imperativ ass en handlungsorientéiert Verb. Wann Dir all Schrëtt mat engem Verb ufänkt, gitt Dir de Lieser en Hiweis iwwer déi néideg Handlung fir de Schrëtt ze kompletéieren. Zum Beispill, ofhängeg vum Produkt iwwer dat Dir schreift, kënnt Dir Är Schrëtt mat engem Kommando starten wéi "Connect", "Confirm" oder "Slide". Allerdéngs start Är Schrëtt net mat enger Äntwert vum System.
   • Zum Beispill, wann de Bildschierm blo gëtt a fänkt mat blénken, start de Schrëtt net mat: "Den Écran blénkt a gëtt blo." Probéiert: "Dréckt an hält den Heem-Schlëssel. Den Ecran blénkt a gëtt blo. "
6. Bestëmmt wéi ee Vocabulaire Dir benotzt. Wann Dir en Yo-Yo Handbuch schreift, wäert Äre Publikum meeschtens kleng Kanner sinn. Benotzt einfach Wierder a Vocabulaire fir z'erklären wéi de Yo-Yo funktionnéiert. Wann Dir e Scannen Elektronenmikroskop Handbuch schreift, besteet Äre Publikum aus héichqualifizéierte Wëssenschaftler déi ganz detailléiert Informatioune kënne verstoen, also scheit Iech net vun der spezialiséierter Vokabular oder nuancéierten Erklärungen.
   • Am Allgemengen probéiert Dir Jargon an technesch Sprooch ze vermeiden.
   • Fir effektiv fir eng breetst méiglech Benotzerbasis ze sinn, probéiert op engem Niveau vu sechste bis siwente Schouljoer vun der Primärschoul ze schreiwen.
7. Wann Dir e Produkt an d'Ausland verschéckt, gitt sécher datt Är Iwwersetzungen korrekt sinn. Astellen en Iwwersetzer fir Äre Benotzerhandbuch an d'Mammesprooch vum Land ze iwwersetzen wou Dir Äre Produkt verschéckt. Dir kënnt och en Online Iwwersetzungsprogramm benotzen, awer frot en Mammesproochler fir d'Iwwersetzung ze liesen a fir Feeler ze kontrolléieren.
   • Wa verschidde Sproochegruppen an Ärem Publikum vertruede sinn, gitt w.e.g. Iwwersetzunge vum Handbuch an all relevant Sprooch.
   • Den Iwwersetzer muss mam Produkt vertraut sinn, well et ka verschidde Wierder an der Zilsprooch fir spezifesch Begrëffer sinn, déi net Wuert fir Wuert Iwwersetzunge sinn.
8. Schreift a kuerze Sätz. Amplaz vun e puer laange Paragrafen benotzt Dir vill kuerz Paragrafen. Kuckt no logesche Pausen an all Sektioun a verdaut nëtzlech Informatioun an engem oder zwee Sätz Stécker. Datselwecht gëllt um Sazniveau. Halt Är Sätz kuerz an einfach, anstatt laang a verbot.
   • Wann e Schrëtt ze laang gëtt, deelt en op méi kleng Schrëtt of. Dëst wäert d'Wuertzuel net reduzéieren, awer d'Linnebriecher maachen et méi einfach ze liesen.
9. Kontrolléiert d'Handbuch fir Feeler. Eng Handbuch ka Kredibilitéit verléieren wéinst Grammatik a Rechtschreiffeeler. Hutt e Kolleg oder technesche Schrëftsteller och d'Handbuch z'änneren an ze liesen. Nieft der Orthographie an der Grammatik sollt e Korrektor op déi folgend oppassen:
   • Passiv Stëmm
   • Onkloer oder duerchernee Sprooch
   • Wéckelt Sazstruktur
   • Iwwerdriwwe laang Paragrafen

Tipps

• D'Leit léieren op verschidde Weeër; Wa méiglech an ubruecht, schreift visuell Hëllefsmëttel oder Linken op OnlineVideoen am Handbuch fir visuell orientéiert Lieser opzehuelen.