Enhavo
kaŝi
Kiel Verki Klarajn kaj Koncizajn Uzantajn Manlibrojn
Kio estas uzantmanlibro?
Estas diversaj nomoj por uzantmanlibro. Teknikaj dokumentoj, prizorgaj manlibroj kaj instrukcioj estas ĉiuj nomoj, kiuj rilatas al la sama objekto. Uzantmanlibro estas farita por helpi klientojn uzi vian produkton aŭ servon ĝuste aŭ solvi problemojn kiuj okazas dum uzo. Ili povas esti disponeblaj en presita, cifereca, aŭ ambaŭ formatoj.
Uzaj manlibroj provizas la finuzanton per ampleksaj, paŝo post paŝo instrukcioj kaj iom da subteno por problemoj. Enhavtabelo devus ĉeesti en ĉiu uzantmanlibro ĉar ili estas referencmaterialoj prefere ol libroj, kiuj devus esti legitaj de komenco ĝis fino. Vi devus aldoni rapidan aŭ komencan lernilon en vian uzantmanlibron por ke uzantoj facile sentiĝu trankvilaj komencante uzi la produkton.
specoj de uzantmanlibroj
Por diversaj temoj kaj celoj, uzantmanlibroj povas esti produktitaj. Jen kelkaj el viaj eblecoj, do ni rigardu ilin.
- Instrukcia Manlibro
Instrukciomanlibro estas speco de uzantgvidilo kiu ofertas simplajn instrukciojn por uzi produkton en la maniero kiel ĝi estis intencita por esti uzita. - Manlibro pri Trejnado
Ĉi tiu speco de uzantgvidilo ofertas liston de gvidlinioj por fini certan taskon, projekton aŭ laboron. - Manlibro pri Servo
Servaj manlibroj estas uzantgvidiloj, kiuj priskribas kiel prizorgi kaj prizorgi pecon de maŝinaro aŭ ekipaĵo ĉe malsamaj stages de ĝia vivdaŭro. - Uzanto Manlibro
Uzantmanlibroj estas teknikaj publikaĵoj, kiuj klarigas kiel uzi aŭ funkcii konvene produkton. - Operacia Manlibro
Roloj, devoj kaj proceduroj specifaj por komerco aŭ organizo estas priskribitaj en operaciaj manlibroj. - Organiza Politika Manlibro
Organiza politika manlibro estas la dokumentaro difinanta la politikojn, praktikojn kaj plej bonajn praktikojn de firmao. - Norma Operaciaj Proceduroj (SOPoj) Manlibro
Uzantoj profitas de la detalaj instrukcioj de manlibro pri normaj operaciumoj por plenumi establitajn procedurojn.
Kial via komerco bezonas uzantmanlibrojn?
Homoj estas pli bone ekipitaj por trakti problemojn memstare kun la subteno de uzantmanlibro. Deca uzantmanlibro povas doni al viaj klientoj la ilojn, kiujn ili bezonas por rapide kaj efike atingi la valoron, kiun ili deziras de via produkto aŭ servo en la hodiaŭa tuja kontentiga kulturo.
Bonega klientservo devas esti kompletigita per uzantmanlibroj. Verki bonegajn uzantmanlibrojn provizos la sekvan avantaĝontagestas por via kompanio:
- Por simpligi aliĝon kaj trejnadon
Bone verkitaj uzantgvidiloj povas simpligi la eniĝajn kaj trejnajn procedurojn. Tio estas ĝusta, disvolvante kaj efektivigante altnivelajn uzantmanlibrojn, kaj viaj dungitoj kaj viaj konsumantoj gajnos.
Via firmao povas uzi uzantgvidilojn por helpi novajn dungitojn trapasi kelkajn el la procezoj kaj sistemoj kiuj estas parto de iliaj novaj roloj prefere ol nur starigi malfacilajn personajn trejnajn sesiojn, kiuj havas signifajn tempon kaj financajn elspezojn. Ĉar dungitoj povas lerni dum plenumado de la devoj rilataj al siaj postenoj pro la uzantgvidiloj, povas esti malpli da horoj perditaj dum enŝipiĝo. - Por Redukti Subtenan Elspezon
Uzantgvidiloj estas bonega aldono al viaj klientservaj klopodoj por la konsumanto, sed ili ankaŭ servas la komerciston bone kiel komponanton de la klientsubtena sistemo.
Klientoj pli verŝajne trovos solvojn tuj kaj malpli verŝajne bezonos kontakti teknikiston aŭ reprezentanton por speciala subteno kiam vi donas al ili rapidan aliron al serĉebla uzantgvidilo. - Por konservi tempon
Kaj viaj klientoj kaj viaj dungitoj, de enirnivela personaro ĝis administrado, povas ŝpari tempon uzante uzantmanlibrojn. Kiam uzantmanlibroj estas haveblaj al viaj klientoj, ili ne devos perdi tempon por provi trovi informojn pri kiel uzi produkton ĉar ili tuj havos rektan aliron al tiuj informoj.
Kiam viaj dungitoj estas ekipitaj per utilaj uzantmanlibroj, ili ne devas perdi tempon sendepende serĉante solvojn aŭ monopoligante la atenton de siaj kunlaborantoj kaj administrantoj per demandoj, ĉar ili havas aliron al la solvoj ĝuste en sia uzantmanlibro! - Minimigi Respondecon
Unu aliro por pruvi, ke vi ĝisfunde testis vian produkton kaj scias kiel uzi ĝin sekure, estas skribi kaj distribui uzantmanlibrojn. Ĉi tio povas signife malaltigi iujn ajn obligaciojn ligitajn kun produkti ion por la ĝenerala publiko.
Havi avertojn kaj sekurecajn antaŭzorgojn skribitajn kaj alireblajn por uzantoj per uzantgvidilo estas efika (kvankam ne erarebla) maniero eviti jurajn problemojn rilate al vundoj aŭ aliaj damaĝoj kaŭzitaj de misuzo se la produkto, kiun vi vendas, povus esti danĝera por uzantoj (pensu. hejtiloj, elektraj iloj, ktp.).
Kiuj komponantoj konsistigas la plej bonajn uzantmanlibrojn?
Estas iuj plej bonaj praktikoj pri dokumentado de finuzantoj por aliĝi ne grave, kvankam ĉiu produkto estas unika kaj bezonos apartajn komponantojn por generi vere bonegan uzantan dokumentadon.
- Simpla lingvo
Nenio pli koleros viajn klientojn—krom ne oferti unu—ol malkovri, ke ilia uzantmanlibro estas plena de ĵargono kaj malfacile komprenebla lingvo. Viaj uzantinstrukcioj estas malfacile uzeblaj pro ĉi tiuj lingvaj elektoj, kiuj ankaŭ ne antaŭenigas elstaran klientan servon. Certigi, ke vi skribas por la uzanto, ne por la programisto, estas decida komponanto por krei bonegajn uzantgvidilojn. Ne supozu, ke via finuzanto scias aŭ konas ion ajn. Akronimoj, ĵargono kaj oficeja terminologio igos viajn klientojn sentiĝi misinformitaj, frustritaj kaj nepreparitaj. La agrabla punkto por produkti uzantmanlibron estas ekvilibra inter ne skribi kvazaŭ viaj konsumantoj estas infanoj (krom se, kompreneble, ili estas!) kaj doni al ili la kroman helpon, kiun ili bezonas por tute kompreni kiel uzi la produkton, simple. lingvo. - Simpleco
Verki uzantmanlibron postulas konservi aferojn simplaj. Ĉi tiu koncepto devus esti reflektita en kaj la enhavo kaj la dezajno. Se vi troŝtopas vian dokumentadon per komplikaj bildoj kaj longaj tekstoj, ĝi aperos tro kompleksa kaj malfacile komprenebla. Ĉi tiu speco de uzantmanlibro verŝajne timigos vian uzanton kaj gvidos ilin voki vian helplinion prefere ol provi mem eltrovi ilian problemon. - Vidaĵoj
La maksimo “Montru, ne diru” estas bazŝtono de uzantmanlibro. Komentitaj ekrankopioj, filmoj kaj alia vida enhavo estas ekstreme helpema por kompreni konceptojn. Ofte estas multe pli utile vidi ion en ago ol legi pri ĝi. Vidaĵoj ne nur rompas longajn tekstojn, sed ili ankaŭ reduktas la kvanton de teksto en uzantmanlibroj, kiuj povas timigi. Estis pruvite, ke homoj retenas vidajn informojn 7% pli rapide ol ili faras skribajn informojn. En Techsmith-studo, estis ankaŭ montrite ke 67% de homoj plenumis taskojn pli efike kiam ricevis instrukciojn kiuj inkludis komentitajn ekrankopiojn prefere ol vortoj sole por transdoni informojn. - Fokuso sur la problemon solvi
Estas sufiĉe verŝajne, ke iu aĉetis vian produkton por trakti problemon. Necesas resti koncentrita pri ĉi tiu afero dum redaktado de la uzantmanlibro, kiu estos inkluzivita kun la produkto. Anstataŭ listigi kaj diskuti ĉiujn funkciojn, kiujn via produkto ofertas aŭ la interesajn dezajnelementojn, kiujn vi enkorpigis, informu viajn uzantojn pri ili en maniero, kiu faciligas la uzon de la produkto. Metu la problemon solvitan en la kuntekston de la trajtoj kaj avantaĝoj de via produkto kiam vi priskribas ilin. - Logika fluo kaj hierarkio
Por evidentigi al la uzanto, kion ili lernos de ĉiu sekcio de via uzantmanlibro, uzu titolojn kaj subtitolojn, kiuj sekvas klaran hierarkian strukturon. Por senpene gvidi viajn klientojn tra ĉio, kion ili bezonas scii de komenco ĝis konkludo, la hierarkio, kiun vi elektas, devas sekvi logikan fluon. Certigu, ke vi komencas kun la bazaĵoj kaj korpigu logikan progresadon al la pli kompleksaj funkcioj de via produkto. - Listo de enhavoj
Via uzantgvidilo estos plej helpema al legantoj se ĝi komenciĝas per enhavtabelo. Sen devi trafosi multajn paĝojn da informoj senrilataj al la nuna problemo, kiun ili alfrontas, ĝi estas konata aliro por iu rapide kaj facile esplori dokumenton. - Faru ĝin serĉebla
Eĉ se vi povus presi viajn uzantmanlibrojn, verŝajne cifereca dokumentaro estos via ĉefa prioritato. Tre verŝajne, viaj uzantmanlibroj estos uzataj plej ofte en cifereca formato en mondo, kie la plimulto de homoj havas inteligentan telefonon kun ili ĉiam. Aldoni serĉeblan funkcion al viaj ciferecaj uzantmanlibroj antaŭenigos ravan facilecon por uzantoj, kiuj volas solvi problemon per aliro al ĝi, simile al kiel enhavtabelo servas por direkti uzantojn al la ĝusta loko en presa dokumento. - Alirebleco
Eblas, ke iuj el la homoj, kiuj postulas vian uzantmanlibron, povus profiti de ekstra helpo por certigi, ke ĝi funkcias ĝuste. Sendepende de ĉu ili estas postulataj de leĝo, alireblecoj estas ĝenerale bona praktiko. Konservi alireblecojn en viaj uzantmanlibroj estas nur bonega komerca praktiko. Dezajni uzantgvidilojn kun enhavo alirebla por uzantoj, kiuj povus havi vidajn, aŭdeblajn aŭ kognajn defiojn, estas decida. - Bone desegnita
Konsideru vian spektantaron kiam vi kreas viajn uzantgvidilojn. Ili multe pli emas uzi ĝin efike se vi faras ion, kion ili ĝuas rigardi! Evitu uzi longajn tekstoblokojn kaj havigu multe da blanka spaco. Kombini ĉi tiujn du trajtojn povas helpi konsumantojn ŝajni malpli timigaj kaj fari lerni ion novan ŝajni ekscita prefere ol minaca. La "montri, ne diru" aliro, kiun ni priskribis pli frue, ankaŭ validas ĉi tie. Por kaj presitaj kaj ciferecaj uzantmanlibroj, aldoni bildojn kaj fotojn al la teksto estas bonega alternativo. Por ciferecaj uzantmanlibroj, videoj kaj GIFoj ofertas intereson kaj helpeman elementon. Se via kompanio havas stilgvidilon, via dezajno devus sekvi ĝin; alie, se vi funkcias sen unu, estas grave konservi vian uzantgvidilon konsekvenca. La tiparo kaj kolorskemoj uzataj ĉie en la papero, kaj ideale tra ĉiuj viaj uzantgvidiloj, devus esti konsekvencaj. - Komentoj de realaj klientoj aŭ beta-testiloj
Vi ne povos determini ĉu aŭ ne la uzantgvidiloj, kiujn vi preparis, estas kiel eble plej sukcesaj ĝis vi serĉos kaj aŭskultos komentojn de la homoj, kiuj efektive uzos vian produkton. La uzantgvidiloj, kiujn vi disvolvas por via produkto, devas konsideri la problemojn, kiujn homoj havas kun ĝi. Vi eble lernos ion, kio ŝajnas ege evidenta, sed estas multe pli bona ŝanco, ke vi lernos ion, kio helpos vin kompreni la bezonojn de la klientoj, kiujn vi provas atingi.
Kiel mi skribas uzantmanlibron?
Fari uzantmanlibron estas decida tasko, kiu povas havi grandan efikon al via kompanio kaj al la konsumantoj, kiujn vi volas servi. Ni simpligis la procezon evoluigi uzantmanlibron por ke vi povu facile sekvi ĉar ĝi povas esti superforta.
- Identigu la uzantojn
Trovi la ricevanton de via komunikado estas esenca komenca paŝo, same kiel kun iu ajn alia komunikado, kiun vi generas. La celita publiko de via uzantmanlibro helpos vin decidi pri aferoj kiel la tono, la nivelo de detalo por provizi kaj kiel liveri la enhavon. Verki uzantgvidilon por la finuzanto de via produkto estas signife malsama ol verki unu por teknika inĝeniero. La unua paŝo estas determini vian publikon. - Fokusu pri la problemo
Uzantmanlibroj estas faritaj por helpi pri problemo-solvado aŭ instrukcii iun pri kiel fari ion novan. Vi devas determini precize kion via uzantmanlibro celas fari kaj certigi konservi tiun fokuson.
Povas esti tente plivastigi la temon kaj diskuti multajn funkciojn aŭ aplikojn por via produkto. Ĉi tio povas frustri uzantojn kaj konduki al vokoj al via klientsubtena linio malklarigante la aŭtentan respondon, kiun ili postulas.
Se via kliento estas konsumanto lernanta kiel uzi la produkton aŭ teknikisto, kiu bezonas ripari ĝin, koncentriĝu pri la preciza solvo, kiun ili postulos. - Uzu sinsekvan aliron
La instrukcioj de via uzantmanlibro devas esti aranĝitaj en la sinsekva ordo necesa por fini la laboron. Listigu ĉiun paŝon por komenci. Poste, penu fari la taskon dum vi aliĝas al la precizaj paŝoj, kiujn vi skizis en la donita ordo. Dum vi trapasas vian originalan liston, estas eble, eble eĉ verŝajne, ke vi trovos iun ajn stages kiuj mankas. Aldone, vi eble trovos, ke io, kion vi iam kredis, estis ununura tasko, efektive devas esti dividita en plurajn agadojn por klareco.
Certigu, ke vi specifis klaran rezulton por ĉiu sinsekva paŝo, kiun vi asignis, antaŭ ol transiri al la sekva fazo de verkado de uzantgvidilo. Antaŭ ol transiri al la sekva nivelo, la legantoj devas esti tute klaraj pri tio, kion ili volas plenumi kaj kiel ĝi devus ŝajni. - Map uzanta vojaĝo
Kompreni kiel viaj konsumantoj planas uzi vian produkton kaj simpligi al ili fari tion estas la celoj de produktado de uzantgvidilo. Vi devas klopodi kompreni la problemon, kiun la konsumanto provas solvi aŭ la celon, kiun ili provas plenumi, uzante vian solvon, kaj ankaŭ kiel ili okupiĝas pri via komerco. Vi povas plani la paŝojn necesajn por gvidi la klienton tra la procezo uzante ĉi tiujn detalojn por bildigi ilian vojaĝon de problemo al solvo. - Elektu Ŝablonon
La tasko verki kaj disvolvi uzantmanlibrojn povas esti multe pli simpla ol vi povus atendi kreante serion da ŝablonoj. Via proceduro povas esti simpligita, kaj konsistenco fariĝus multe pli realisma celo.
En via uzantmanlibro ŝablono, krom difinado de detaloj kiel tiparoj (tipo kaj grandeco), kontrastaj postuloj kaj kolorskemoj, vi ankaŭ devus inkluzivi la jenajn:- Areo asignita por enkonduko
- Distingaj subsekcioj kaj sekcioj
- Via elektita formato por transdoni serion da agoj
- Singardaj notoj kaj avertoj
- Areo asignita por konkludo
- Skribu simplan kaj facile sekvan enhavon
La materialo de via uzantmanlibro devus esti tiel simpla kaj simpla por kompreni kiel farebla. Gravas pensi kaj analizi la formaton kaj enhavon por klareco kaj oportuno.
Certigu, ke ĉiu fazo de la procezo nur skizas unu taskon kaj utiligu kiel eble plej klaran kaj mallongan lingvon. Nepre konvene modifi vian tekston ĝis vi havas uzantmanlibron, kiu enhavas nur la informojn vere necesajn. - Alproksimiĝu al ĉiu uzanto kiel novulo
Supozu, ke la leganto de via uzantmanlibro havas neniun antaŭan scion pri via produkto dum kreado de ĝi. Skribu kvazaŭ vi parolas al laiko.
Ĉia uzo de ĵargono aŭ teknika lingvo estu evitita. Nature, estos tempoj kiam ĝi devas esti evitita, sed ĉi tiuj devus esti la absoluta escepto. - Testu la instrukciojn de la produkto kun novuloj
La testa fazo de la uzanta mana krea procezo estas decida. La temo de la eksperimentado havas signifan efikon al la rezulto.
Testado devus ideale esti farita sur homoj, kiuj neniam uzis vian produkton aŭ vidis la dokumentadon. Dum vi trapasas la uzantmanlibron, rigardu ilin kiam ili kompletigas la procezon kaj registras kie ili blokiĝas. Tiam, la informoj devus esti ĝisdatigitaj taŭge.
Nur la helpo de la uzantmanlibro devus esti necesa por viaj elproviloj funkciigi la produkton. Ili ne devus peti pli da helpo. La Sovetunia Gvidilo devus havi ĉiujn informojn, kiujn ili postulas. - Konstruu enhavon uzante praktikan aliron
Ĉiu peno estu farita por proponi konkretan ekzamplesoj kaj detalaj priskriboj de iuj rezultoj, kiujn uzantoj povus sperti post sekvado de ĉiu paŝo en la uzantmanlibro. La uzanto devas konscii pri ajnaj sugestoj, kiujn ili povus ricevi de la produkto, kaj ankaŭ pri ajnaj eventualaj vidindaĵoj aŭ sonoj, kiujn ili povus renkonti survoje. - Klarigu simbolojn, ikonojn kaj kodojn frue
Vi eble bezonos uzi ikonojn, simbolojn aŭ kodojn dum vi verkas uzantmanlibron por helpi provizi la necesajn instrukciojn. Por malhelpi leganton konfuzon aŭ frustriĝon, estas grave identigi ĉi tiujn kiel eble plej frue en via uzantmanlibro.
Oftaj Demandoj pri Manlibro
Kio ĝuste estas uzantmanlibroj?
Uzantdokumentado estas informoj provizitaj en formo de uzantmanlibroj aŭ uzantgvidiloj kaj celas helpi finajn uzantojn en interagado kun produkto sukcese.
- Kiaj uzantdokumentoj ekzistas?
Fizika dokumentaro, kiel ekzemple broŝuroj aŭ manlibroj, estis tradicie utiligita por oferti uzantdokumentadon. Nuntempe, uzantmanlibroj estas produktitaj kaj distribuitaj pli ofte ciferece. - Kio estas enhavita en uzantmanlibroj?
Instrukcia manlibro aŭ uzantgvidilo uzas bonan dezajnon, klaran skribon kaj problemo-solvantan fokuson. Mi devas havi enhavtabelon, aliĝi al logika hierarkio kaj fluo, kaj proponi enhavon alirebla. Aldone, bona uzantmanlibro estos serĉebla kaj konsideros uzanton reviews. - Kiel estas farita uzantdokumento?
Simplaj paŝoj povas esti uzataj por evoluigi uzantmanlibrojn. La celoj de la uzantgvidilo unue devas esti determinitaj, kaj strategio devas esti evoluigita por ebligi ilian plenumon. La uzantmanlibro devas esti provita kaj ĝisdatigita laŭbezone antaŭ esti publikigita. Fine, gravas konservi la uzantgvidilon ĝisdatigita, farante ŝanĝojn kiam novaj ĝisdatigoj aŭ eldonoj estas aldonitaj.