Manwal għall-utent huwa gwida komprensiva li tgħin lill-utenti jifhmu u joperaw prodott jew servizz. Biex toħloq manwal għall-utent effettiv, segwi dawn il-passi:
- Iddefinixxi l-udjenza fil-mira tiegħek: Identifika l-utenti primarji tal-prodott jew is-servizz tiegħek. Ikkunsidra l-livell ta’ kompetenza teknika tagħhom u tadatta l-istil tal-kitba tiegħek kif xieraq.
- Stabbilixxi l-iskop u l-ambitu tal-manwal: Iddetermina l-għanijiet u l-għanijiet tal-manwal. X'tixtieq li l-utenti jitgħallmu jew iwettqu? Iddeskrivi b'mod ċar l-ambitu biex tiżgura li l-kontenut ikun iffukat u rilevanti.
- Iġbor l-informazzjoni meħtieġa: Irriċerka u kkumpila l-informazzjoni rilevanti kollha dwar il-prodott jew is-servizz, inklużi speċifikazzjonijiet tekniċi, karatteristiċi, funzjonijiet, issolvi l-problemi u manutenzjoni.
- Organizza l-kontenut: Oħloq sommarju jew tabella tal-kontenut li torganizza l-informazzjoni b'mod loġiku u faċli biex issegwi. Ikkunsidra l-vjaġġ tal-utent u grupp suġġetti simili flimkien.
- Ikteb istruzzjonijiet ċari u konċiżi: Uża lingwaġġ sempliċi, vuċi attiva, u sentenzi qosra biex il-kontenut ikun faċli biex jinftiehem. Evita lingwaġġ u termini tekniċi sakemm ma jkunx assolutament meħtieġ. Inkludi struzzjonijiet pass pass, illustrazzjonijiet, u dijagrammi meta meħtieġ.
- Inkorpora viżwali: għajnuniet viżwali bħal stampi, screenshots, u dijagrammi jistgħu jtejbu ħafna l-fehim tal-utent. Kun żgur li huma ċari, preċiżi u ttikkettjati b'mod xieraq.
- Uża formattjar u stil konsistenti: Stabbilixxi format u stil konsistenti għall-intestaturi, is-subintestaturi, il-listi, u elementi oħra. Dan jgħin biex itejjeb il-leġibbiltà u jagħmel il-manwal jidher aktar professjonali.
- Inkludi glossarju u indiċi: Inkludi glossarju biex tiddefinixxi termini tekniċi u indiċi biex tgħin lill-utenti jillokalizzaw malajr suġġetti speċifiċi.
- Ittestja u tirrevedi: Ikollhom grupp ta' utenti jew kollegi mill-ġdidview il-manwal għaċ-ċarezza, l-eżattezza, u l-użabilità. Iġbor ir-reazzjonijiet tagħhom u agħmel reviżjonijiet kif meħtieġ.
- Aqra l-provi u editja: Aqra bir-reqqa l-manwal għal żbalji ta’ grammatika, ortografija u punteġġjatura. Kun żgur li l-viżwali kollha huma mqiegħda sew u referenzjati.
- Disinn u tqassim: Oħloq disinn u tqassim professjonali li jkunu viżwalment attraenti, faċli biex jinnavigaw, u konsistenti mal-identità viżwali tal-marka tiegħek.
- Ippubblika u tqassam: Ladarba l-manwal ikun lest, ippubblikah f'format li jkun aċċessibbli għall-utenti tiegħek, bħal stampar, PDF, jew sistemi ta' għajnuna onlajn. Agħmilha faċilment disponibbli għall-utenti, jew inkluża mal-prodott, fuq tiegħek websit, jew permezz ta 'appoġġ għall-klijent.
Ftakar li żżomm il-manwal tal-utent aġġornat hekk kif il-prodott jew is-servizz tiegħek jevolvi. Regolarment mill-ġdidview u taġġorna l-kontenut biex tiżgura li jibqa' rilevanti u utli.
Mudelli
Ħossok liberu li tniżżel / tikkopja / tuża l-mudelli tal-Manwal tal-Utent li ġejjin:
Mudell tal-Manwal tal-Utent ta' Google Doc
Mudell tal-Manwal tal-Utent PDF
Dokument tal-Kelma Mudell tal-Manwal tal-Utent
Mudell tal-Manwal tal-Utent [Paġni OSX]
Aċċessibilità
Il-ħolqien ta' manwal għall-utent aċċessibbli huwa kruċjali biex jiġi żgurat li l-utenti kollha, inklużi dawk b'diżabilità, ikunu jistgħu jużaw b'mod effettiv il-prodott jew is-servizz tiegħek. Hawn huma xi suġġerimenti dwar kif tagħmel manwal għall-utent aktar aċċessibbli:
-
Uża Lingwa Ċara u Sempliċi: Evita lingwaġġ, akronimi, u terminoloġija kumplessa. Uża lingwaġġ sempliċi li huwa faċli biex tinftiehem. Immira għal leġibbiltà li taqbel ma' firxa wiesgħa ta' livelli ta' qari.
-
Ikkunsidra l-Għażliet ta’ Font: Uża fonts li huma faċli biex jinqraw. Fonts Sans-serif bħal Arial jew Verdana huma tipikament aktar aċċessibbli. Id-daqs tat-tipa għandu wkoll ikun kbir biżżejjed biex jinqara bil-kumdità, tipikament 12-il punt jew akbar.
-
Uża Kuluri ta' Kuntrast Għoli: It-test u l-kuluri tal-isfond għandu jkollhom livell għoli ta 'kuntrast biex jagħmluhom faċli biex jiddistingwuhom. Test iswed fuq sfond abjad huwa l-aktar għażla aċċessibbli.
-
Inkludi Test Alternattiv għal Stampi: Test alternattiv (test alternattiv) huwa deskrizzjoni qasira ta' immaġini li tista' tinqara minn qarrejja tal-iskrin għal dawk b'indebolimenti tal-vista. Kun żgur li kull immaġni, dijagramma, jew grafika fil-manwal tiegħek għandha test alternattiv.
-
Uża Intestaturi u Subintestaturi Deskrittivi: L-intestaturi u s-subintestaturi ifformattjati u deskrittivi kif suppost jistgħu jgħinu lill-qarrejja jinnavigaw fid-dokument, u jistgħu jintużaw minn qarrejja tal-iskrin biex jiddeskrivu l-istruttura tad-dokument.
-
Ipprovdi Captions jew Traskrizzjonijiet għall-Kontenut Awdjo/Vidjo: Jekk il-manwal tiegħek jinkludi struzzjonijiet tal-awdjo jew tal-vidjo, ipprovdi captions jew traskrizzjoni sabiex dawk b'nuqqas ta' smigħ ikunu jistgħu jaċċessaw l-informazzjoni.
-
Kun żgur li l-Manwal huwa Aċċessibbli Diġitalment: Jekk il-manwal jiġi pprovdut b'mod diġitali, għandu jkun f'format li jista' jinqara minn teknoloġiji ta' assistenza. PDFs, pereżempjuample, għandu jkun tagged b'mod korrett sabiex il-qarrejja tal-iskrin ikunu jistgħu jinterpretaw il-kontenut b'mod preċiż.
-
Disinn Loġiku u Navigazzjoni Konsistenti: It-tqassim tal-manwal għandu jkun loġiku u konsistenti, li jista 'jgħin individwi b'diżabilitajiet konjittivi. Dan jinkludi li jkollok sommarju, numri tal-paġni konsistenti, u mod faċli biex wieħed jinnaviga 'l quddiem u lura.
-
Ħalli l-Personalizzazzjoni: Jekk possibbli, iddisinja l-manwal diġitali tiegħek sabiex l-utenti jkunu jistgħu jippersonalizzaw il-wiri biex jissodisfaw il-ħtiġijiet tagħhom, bħall-bdil tad-daqs tat-test jew il-kulur tal-isfond.
-
Test għall-Aċċessibilità: Fl-aħħarnett, ittestja l-manwal tiegħek ma’ varjetà ta’ utenti, inklużi dawk li jużaw teknoloġiji ta’ assistenza. Ir-rispons tagħhom jista 'jgħinek tikxef u tirranġa kwalunkwe kwistjoni ta' aċċessibbiltà.
Li tagħmel il-manwal tal-utent tiegħek aċċessibbli mhux biss tiżgura konformità mar-regolamenti bħall-Att dwar l-Amerikani b'Diżabilità (ADA), iżda ttejjeb ukoll l-esperjenza ġenerali tal-utent għall-utenti kollha.
FAQ
Manwal għall-utent jiggwida lill-utenti dwar kif jużaw prodott jew servizz. Jipprovdi struzzjonijiet pass pass, pariri għall-aħjar użu, informazzjoni dwar is-sigurtà, struzzjonijiet ta’ manutenzjoni, u pariri dwar is-soluzzjoni tal-problemi.
L-udjenza primarja għal manwal tal-utent hija l-utent finali tal-prodott jew servizz. Madankollu, jista 'jkun utli wkoll għat-tekniċi, ir-rappreżentanti tas-servizz tal-konsumatur, u oħrajn li jeħtieġu jifhmu l-prodott jew is-servizz.
Manwal għall-utent għandu jinkludi overview tal-prodott jew servizz, struzzjonijiet pass pass dwar kif tużah, prekawzjonijiet ta’ sigurtà, istruzzjonijiet ta’ manutenzjoni, pariri dwar is-soluzzjoni tal-problemi, glossarju ta’ termini, u informazzjoni ta’ kuntatt għall-appoġġ tal-klijent.
Manwal għall-utent għandu jiġi organizzat b'mod loġiku li jallinja mal-vjaġġ tal-utent. Dan spiss ifisser li tibda b'struzzjonijiet ta 'setup jew installazzjoni, imbagħad timxi fuq funzjonijiet bażiċi, karatteristiċi avvanzati, manutenzjoni u soluzzjoni tal-problemi.
Iva, viżwali bħal dijagrammi, ritratti, u screenshots jistgħu jtejbu b'mod sinifikanti l-fehim tal-utent tal-istruzzjonijiet u jagħmlu l-manwal aktar impenjattiv.
Biex tagħmel manwal għall-utent faċli biex tinftiehem, uża lingwaġġ ċar u sempliċi, jaqsam il-proċessi kumplessi fi struzzjonijiet pass pass, inkludi viżwali, u uża l-ifformattjar (bħal listi bil-bulleti, headers, u test b'tipa grassa) biex tenfasizza informazzjoni importanti.
Il-manwali tal-utent jistgħu jkunu stampati, diġitali (bħal PDF), jew saħansitra interattivi (bħal ċentru tal-għajnuna onlajn). L-aħjar format jiddependi fuq il-prodott tiegħek, l-udjenza tiegħek, u kif x'aktarx jużaw il-manwal.
Manwal għall-utent għandu jiġi aġġornat kull meta jkun hemm bidliet sinifikanti fil-prodott, is-servizz jew il-proċeduri operattivi. Hija wkoll idea tajba li perjodikament terġa'view u aġġorna l-manwal biex tiżgura li l-informazzjoni tibqa’ preċiża u rilevanti.
L-ittestjar huwa essenzjali fil-ħolqien tal-manwal tal-utent biex jiġi żgurat li l-istruzzjonijiet huma ċari, preċiżi u faċli biex isegwu. Dan spiss jinvolvi li jkollhom utenti reali jew kollegi review il-manwal u tipprovdi feedback.
Biex tagħmel manwal għall-utent involviment, uża ton amikevoli u konversazzjonali, inkludi viżwali, u ipprovdi examples jew każijiet ta' użu. Ukoll, ikkunsidra li tkisser it-test dens b'formattjar u spazju abjad biex tagħmilha aktar leġibbli.
