Ako písať používateľské príručky pre technicky zdatné publikum

Ako písať používateľské príručky pre technicky zdatné publikum

NETECHNICKÉ ZNALOSTI DIVÁKA

netechnické

Ľudia, ktorí technológie pravidelne nepoužívajú alebo si ich uvedomujú, ale nie view pretože je to rozhodujúce pre ich spôsob života, často tvorí publikum, ktoré nie je technicky zdatné.

Poslucháči, ktorí nie sú technicky zdatní, označujú jednotlivcov, ktorí majú obmedzené znalosti alebo sú oboznámení s technológiou a jej súvisiacimi konceptmi. Môžu mať problémy s pochopením technologickej terminológie, môžu mať problémy s ovládaním digitálnych zariadení alebo softvéru a cítia sa ohromení novým technologickým pokrokom.

Pri komunikácii alebo prezentovaní informácií publiku, ktoré nie je technicky zdatné, je dôležité zvážiť jeho úroveň pochopenia a prispôsobiť tomu svoj prístup. Tu je niekoľko tipov, ako efektívne zaujať publikum, ktoré nie je technicky zdatné:

  • Nastavte scénu:
    Urobte informácie, ktoré poskytujete, relevantnejšie a významnejšie pre spotrebiteľov, ktorí nie sú technicky zdatní. Popíšte, ako to ovplyvňuje ich každodenný život alebo ako im to môže pomôcť.Používateľské príručky pre netechnických používateľov
  • Vizualizácia konceptu:
    Na ilustráciu pojmov a uľahčenie ich pochopenia použite diagramy, grafy alebo infografiky. Informácie možno často komunikovať jasnejšie prostredníctvom obrázkov ako prostredníctvom samotného textu.
  • Poskytnite Real-World Examples:
    Aby ste ukázali, ako sa dá technológia použiť alebo ako môže vyriešiť bežné problémy, použite naprampalebo scenáre zo skutočného života. Princípy sú ľahšie pochopiteľné pre publikum, ktoré nemá technické znalosti, keď sa týkajú každodenných udalostí.
  • Podrobné kroky:
    Pri vysvetľovaní rozdeľte proces alebo techniku ​​na jednoduché kroky. Dajte im konkrétne pokyny a možno by ste sa mohli zamyslieť nad využitím ilustrácií alebo obrázkov, ktoré im pomôžu.
  • Ponuka priamej pomoci:
    Ak je to možné, poskytnite praktickú pomoc alebo ukážky. Individuálna pomoc alebo možnosť experimentovať s technológiou pod dohľadom sú často prospešné pre ľudí, ktorí nie sú informovaní o technike.
  • Zachovajte pokoj a povzbudenie:
    Majte na pamäti, že publikum, ktoré nie je informované o technológiách, sa môže cítiť vystrašené alebo premožené technológiou. Keď sa učia, buďte trpezliví, odpovedajte na ich otázky a prejavte im podporu.
  • Ďalšie zdroje:
    Poskytnite doplňujúce informácie, na ktoré sa ľudia môžu neskôr odvolať, ako sú podklady alebo odkazy na používateľsky prívetivé zdroje. Tieto zdroje by mali ponúkať podrobné pokyny alebo rady na riešenie problémov v jednoduchom jazyku a nemali by byť technické.
  • Zhromažďovanie spätnej väzby:
    Po dodaní inštrukcie alebo prezentácie požiadajte o spätnú väzbu, aby ste zhodnotili úspešnosť vašej komunikácie. Netechnickí experti môžu ponúknuť bystré názory na veci, ktoré je potrebné objasniť alebo zlepšiť.

Pamätajte, že každý sa učí vlastným tempom a je dôležité vytvoriť podporné a inkluzívne prostredie pre publikum, ktoré nie je technicky zdatné. Prispôsobením komunikácie a poskytnutím primeranej podpory im môžete pomôcť cítiť sa pohodlnejšie a istejšie pri navigácii vo svete technológií.

POUŽÍVATEĽSKÉ PRÍRUČKY PRE NETECHNICKÉHO DIVÁKA

AUDIENCES

Pri vytváraní používateľských príručiek pre publikum, ktoré nie je technicky zdatné, je nevyhnutné zamerať sa na jednoduchosť, zrozumiteľnosť a pokyny krok za krokom. Tu je niekoľko tipov, ktoré vám pomôžu vytvoriť používateľské príručky, ktoré ľahko pochopia aj technicky zdatní jednotlivci:

  • Použite jednoduchý jazyk:
    Vyhnite sa používaniu zložitej terminológie a technického žargónu. Používajte terminológiu vhodnú pre publikum, ktorá je jednoduchá a bežná. Urobte technické vysvetlenia tak, aby boli zrozumiteľné.
  • Po prvé, základy:
    Koniecview hlavné funkcie produktu alebo softvéru by mali byť uvedené na začiatku používateľskej príručky. oboznámiť používateľov s výhodami a účelom technológie.
  • Objasniť organizáciu obsahu:
    Na uľahčenie skúmania a získavania informácií rozdeľte používateľskú príručku na logické časti a použite nadpisy, podnadpisy a odrážky. Poskytnite obsah pre ľahký prístup.
  • Využite vizuály:
    Pridajte do textu obrázky, snímky obrazovky a iné vizuálne prvky, aby mal väčší zmysel. Netechnickí ľudia môžu mať väčší úžitok z názorných pomôcok na pochopenie pokynov.
  • Podrobné kroky:
    Poskytnite pokyny štýlom krok za krokom a uistite sa, že každý pokyn je presný a stručný. Použite jednotný formát v celej príručke a očíslujte kroky.
  • Uveďte prípadové štúdie a príklamples:
    Zahrňte scenáre zo skutočného sveta a naprampsúbory, ktoré ukazujú, ako používať produkt alebo program. To uľahčuje spotrebiteľom pochopenie a dodržiavanie pokynov.
  • Zdôraznite dôležité informácie:
    Ak chcete zvýrazniť dôležité informácie, upozornenia alebo upozornenia, použite nástroje na formátovanie, ako je tučný text alebo kurzíva, zvýrazňovanie alebo farebné kódovanie.
  • Odstrániť predpoklady:
    Nepredpokladajte technické alebo predchádzajúce znalosti. Za predpokladu, že nemáte predchádzajúce znalosti o technológii, popíšte aj tie najzákladnejšie úlohy a pojmy.
  • Časté otázky a riešenie problémov:
    Zahrňte časť o riešení problémov, ktorá sa zaoberá častými problémami alebo ťažkosťami, s ktorými sa spotrebitelia môžu stretnúť. Buďte pripravení na často kladené otázky (FAQ) a ponúknite stručné odpovede.
  • Review a test:
    Pred dokončením otestujte používateľskú príručku s netechnickými pracovníkmi, aby ste získali vstupné informácie. Upravte príručku na základe ich spätnej väzby a uistite sa, že zohľadňuje ich potreby a úroveň porozumenia.
  • Poskytovaná dodatočná podpora:
    Zahrňte linku pomoci alebo kontaktné údaje, aby sa používatelia mohli skontaktovať, ak potrebujú ďalšiu pomoc. Zamyslite sa nad poskytovaním doplnkových materiálov, ako sú online manuály alebo videonávody pre vizuálnych študentov.

Pamätajte si, že používateľské príručky pre používateľov, ktorí nie sú technicky zdatní, by mali byť užívateľsky prívetivé, prístupné a napísané spôsobom, ktorý buduje dôveru a umožňuje používateľom úspešne sa orientovať v technológii.

AKO VYSVETLIŤ TECHNICKÉ MYŠLIENKY NETECHNICKÉMU publiku

  • Ako komunikovať technické koncepty netechnickým ľuďom
    Vývojári a inžinieri majú jedny z najúžasnejších súprav zručností medzi dnešnými profesionálmi v kariére, vyleštené rokmi technického školenia a praktických skúseností. S rozvojom technológií však rastie aj požiadavka na efektívnu komunikáciu. Úspešné interakcie na pracovisku v technicky zdatných spoločnostiach ako Google, Facebook a Microsoft často závisia od schopnosti technických profesionálov podporovať spoluprácu, komunikovať svoje nápady a riešiť problémy so svojimi netechnickými spolupracovníkmi alebo šéfmi.
    Aký je teda najlepší spôsob, ako môže technický expert sprostredkovať technické koncepty netechnickému publiku?
    podobne ako by ste prezentovali akýkoľvek iný typ informácií: stručne a efektívne. Z toho nevyplýva, že nemôžete vytvoriť pútavý príbeh alebo prezentovať svoje poznatky jednoduchým, zábavným alebo zapamätateľným spôsobom len preto, že vaše posolstvo je relatívne zložité. Bude to však vyžadovať úsilie.
    V tomto príspevku prejdeme piatimi technikami, ktoré môžu programátori, inžinieri, IT špecialisti a iní technickí profesionáli použiť na efektívnejšie sprostredkovanie svojich nápadov. Tieto techniky sa dajú ľahko použiť prakticky na akomkoľvek pracovisku.
  • Na správne vysvetlenie technického materiálu používajte humor a pokoru
    používať humor a pokoru
    Vždy pracujte na tom, aby sa vaše publikum pri diskusii o kóde alebo prezentácii technických informácií cítilo pohodlnejšie. Začnite vtipným priznaním, že ste „počítačový blbecek“ alebo „tech geek“ a vopred sa ospravedlnte, ak budete príliš technický. Napriek vášmu najlepšiemu úsiliu, keď sprostredkúvate nové poznatky, môžu sa laici (rovnako ako iní technickí profesionáli skúsení v iných oblastiach) cítiť, akoby ste sa s nimi rozprávali.
    Základné napätie však môžete znížiť tak, že budete k publiku úprimní a poviete, že nemáte potuchy, ako urobiť finančnú prognózu, ako zvládnuť nahnevaného zákazníka alebo zodpovedať jeho technologickej znalosti. Dajte im vedieť, že si vážite to, čo robia, a veci, v ktorých sú dobrí. Vysvetlite im, že vaším cieľom je, aby lepšie pochopili technológiu a že ich nepochopenie neznamená nedostatok inteligencie.
    Namiesto toho, aby ste sa snažili dokázať, aký ste chytrý alebo informovaný, je dôležitejšie ukázať ľuďom svoju pripravenosť vysvetľovať veci s pokorou.
  • Počas prezentácie venujte veľkú pozornosť publiku
    Počas rozprávania venujte veľkú pozornosť tvárovým a sociálnym kľúčom vášho publika. Môžete zmeniť svoj materiál tak, aby vyhovoval prostrediu, čítaním miestnosti. Cieľom je byť konverzačný vždy, keď odovzdávate svoje technické znalosti netechnickému publiku. Osoba, s ktorou hovoríte, možno počuje o technológii prvýkrát, aj keď ste o nej s ľuďmi diskutovali stokrát a ste odborníkom na túto tému. Pri rozprávaní buďte vždy nadšení a vášniví.
  • Pri odovzdávaní technických informácií používajte naratívne techniky
    Keď máte veľa čo povedať, vyhnite sa tomu, aby ste na svoje publikum vysypali ohnivú hadicu údajov alebo vedomostí. Vyhnite sa nutkaniu vtesnať každý detail do diapozitívu a jednoducho ho prečítať; dajte im čas na spracovanie vášho predmetu.
    Ak sa chystáte použiť PowerPoint na zobrazenie svojho materiálu, majte na pamäti, že každá snímka by mala prezentáciu pridať, nie ju odviesť. Vyhnite sa používaniu nudných obrázkov alebo grafov, ktoré nedokážu vyjadriť váš názor rýchlo a jasne. Každá snímka by sa mala posudzovať v kontexte toho, ako nasmeruje vaše publikum z bodu A do bodu B. Pri zostavovaní prezentácie vždy majte na pamäti svoj cieľ alebo účel.
    Čo je najdôležitejšie na začiatok? Pokúšate sa presvedčiť svojho CMO, že občianski vývojári používajúci platformy bez kódu výrazne znížia počet nevybavených produktov? Alebo možno chcete presvedčiť financie, že váš technický personál potrebuje nové nástroje?
    Za každých okolností je rozprávka presvedčivejšia než len fakty.
    Príbehy, najmä tie, ktoré sú založené na osobnej skúsenosti, sú účinnými nástrojmi na vštepovanie konceptov do mozgu vášho publika. Použite príbehy z nedávnych udalostí alebo relevantné priemyselné publikácie, ak nemáte svoj vlastný osobný alebo relevantný príbeh, o ktorý by ste sa mohli podeliť. Ak napríklad opisujete, ako má nová technológia potenciál všetko zmeniť, spomeňte, ako Steve Jobs podporoval iPod a ako jeho úspech vzdoroval predpovediam investorov.
  • Použite vizuály na ilustráciu zložitých konceptov a postupov
    Písaný text aj hovorené vysvetlenia sú rozhodujúce pre sprostredkovanie myšlienok. Avšak snaha o vizualizáciu vašich predstáv môže byť oveľa efektívnejším komunikačným kanálom, keď je vaším cieľom zjednodušiť technický materiál. prečo? Pojmy naučené čítaním alebo jednoduchým rozprávaním sú ťažšie zapamätateľné ako tie, ktoré sa naučia prostredníctvom vizuálneho obsahu.
    Tento fenomén sa nazýva „efekt nadradenosti obrazu“. Podľa výskumu môže obrázok zlepšiť schopnosť človeka syntetizovať vedomosti o 36 % a môže zvýšiť zapamätanie si informácie o 65 % v porovnaní s 10 % len pri počúvaní. Nemalo by byť žiadnym prekvapením, že veľa ľudí často používa diagramy, modely a iné metódy vizuálnej prezentácie na komunikáciu svojich bodov. Ak hľadáte rýchly a efektívny prístup k vizualizácii a komunikácii vášho materiálu s vašou organizáciou, je tu Lucidchart.
    Vďaka užívateľsky prívetivým šablónam a rozhraniu môžete rýchlo upraviť alebo upraviť svoje pracovné postupy podľa potrieb vášho netechnického publika. Výkonný pracovník nemusí nevyhnutne pochopiť každý komponent diagramu architektúry; len musia vedieť, ako to funguje. Pomocou Lucidchart Cloud Insights môžete jednoducho vytvoriť diagram cloudovej architektúry a odrezať dôležité časti.
    Tieto obrázky a diagramy môžu byť distribuované na diaľku do iných oddelení pomocou Lucidchart's webplatforma, alebo môžu byť zahrnuté do videokonferencie pre komplexnejšiu prezentáciu. V skutočnosti môže užívateľsky prívetivé rozloženie Lucidchart podporiť väčšiu spoluprácu a zlepšiť pracovné vzťahy medzi technickými a netechnickými oddeleniami v celej vašej organizácii.
  • Ak je to možné, vyhnite sa technickému jazyku
    Aj keď vám môže byť používanie skratiek ako GCP a DBMS prirodzené, určitá terminológia môže menej technicky informovaných členov vášho publika znepokojovať alebo nudiť. Ubezpečte sa, že si vaše publikum uvedomuje pozadie situácie tým, že si na to urobíte čas.
    Ak je to len trochu možné, vyhnite sa žargónu a preveďte všetky technické pojmy do bežného jazyka. Ak nie, možno by ste sa mali zamyslieť nad zahrnutím definícií akýchkoľvek technických skratiek a fráz na vaše snímky alebo poskytnúť k nim referenčnú príručku.
  • Pri vysvetľovaní technických tém zdôraznite dopad
    Majte na pamäti, že vaše publikum nemusí považovať materiál, ktorý považujete za fascinujúci (alebo dôležitý). Keď hovoríme o technológii, je výhodnejšie zamerať sa na jej výhody a nie na technické detaily. Povedzme, že naprample, že ste odporúčali prijatie nových opravných, potlačovacích a monitorovacích protokolov pre vašu sieť; Namiesto toho, aby ste hukotali dookola o najnovších inováciách autentifikačného procesu, mali by ste sa sústrediť na diskusiu o tom, ako vystavenie kybernetickým útokom stálo americké podniky 654 miliárd USD strateného kapitálu len v roku 2018.
    Vaše kontakty s generálnymi riaditeľmi a inými netechnickými pracovníkmi vo vašej spoločnosti budú oveľa efektívnejšie, ak sa sústredíte na iniciatívy a oblasti bolesti, ktoré sú pre vaše publikum najdôležitejšie.