Hvordan man laver en god quick-reference guide

Hvad er en quick-reference guide

En quick-reference guide er enhver dokumentation, der indeholder en eller to sider med en kortfattet vejledning om, hvordan man bruger et produkt. De kan være meget detaljerede eller meget enkle, alt efter hvad der er behov for.

Næsten alle produkter kræver en eller anden form for dokumentation for at hjælpe kunderne med at forstå, hvordan de skal bruge det. Afhængigt af produktet kan disse brugervejledninger eller produktmanualer nogle gange være hundredvis af sider lange med sider fulde af lange tekstblokke.

Med andre ord kan de være ret skræmmende, især for nye brugere.

Det er klart, at du har brug for dokumentation, der dækker alt, hvad dit produkt kan. Men nogle gange vil dine kunder bare gerne vide noget uden at skulle vade gennem et væld af indhold for at finde det.

En quick-reference-guide er en perfekt måde at give dine brugere et væld af hurtigt tilgængelige oplysninger på en letfordøjelig og engagerende måde.

Her er, hvad du lærer:

• Hvorfor er det vigtigt?
• De essentielle elementer til at skabe en god quick-reference guide.
• Sådan laver du en quick-reference guide i seks nemme trin.
• Fælles typer af quick-reference guides.
• Quick-reference guide dos and don’ts.

Hvorfor er det vigtigt?

De er især nyttige, når et produkt eller en tjeneste har en række forskellige eller avancerede funktioner, men også kan betjenes mere enkelt.

For eksempel opgraderede jeg for et par år siden mit grundlæggende komfur med en pænere, mere avanceret model. Mens ovnen på det gamle komfur grundlæggende var tændt eller slukket med temperaturindstillinger, havde mit nye kom med alle mulige nye funktioner.

Der var en almindelig bageindstilling samt konvektionsbagning, stegning, brødfrostning og meget mere. Derudover har den nye knapper og en digital visning, mens den gamle bare var en drejeknap, som man drejede på for at tænde den og indstille temperaturen.

Nu har jeg bagt et brød eller to i min tid, men lad os være ærlige. Det meste af tiden, når jeg bruger min ovn, opvarmer jeg pizzabrød eller rister noget hvidløgsbrød, så jeg bruger for det meste den almindelige bageindstilling.

Glædeligt nok leverede producenten en quick-start guide (en af de mest almindelige typer quick-reference guides), der hjælper mig med at lave grundlæggende bagning. I et par korte trin vidste jeg præcis, hvad jeg skulle gøre for at bruge ovnen til dens mest grundlæggende funktion.

Dernæst, når jeg ville arbejde med de mere avancerede funktioner, kunne jeg dykke dybere ned i den fulde produktmanual.

Snaphåndbøger giver dine brugere mulighed for hurtigt og nemt at finde de oplysninger, de har brug for til at udføre en bestemt opgave eller et sæt af opgaver. De erstatter ikke en komplet brugermanual, men de udgør en fantastisk supplerende måde at levere oplysninger på.

Godt nok gør Snagit det super enkelt at oprette en quick-reference guide.

Her er alt, hvad du behøver at vide om at lave en quick-reference guide af høj kvalitet på ingen tid.

Er en quick-start guide en quick-reference guide?

Det hurtige svar: Ja!

Som nævnt ovenfor er en quick-start-guide en af de mest almindelige typer quick-reference-vejledninger. Så selv om ikke alle quick-reference guides er quick-start guides, er alle quick-start guides quick-reference guides.

Giver det mening?

Sådan laver du en quick-reference guide i seks nemme trin

Og hvis du ikke har de rigtige værktøjer, er det her, at det kan blive rigtig svært. Det kan f.eks. være tidskrævende at forsøge at sætte det hele ind i et Microsoft Word-dokument.

Og hvis du ikke har adgang til en professionel designer, kan det være lidt skræmmende at sikre, at din quick-reference-guide ser godt ud.

Men sådan behøver det ikke at være.

Jeg vil fortælle dig en lille hemmelighed: Når det kommer til at designe godt indhold, er Snagit 2020-skabelonerne min superkraft.

De giver professionelt udseende designs, som du kan bruge til at oprette hurtige vejledninger med træk-og-slip-lethed.

Snagit 2020 leveres fyldt med skabeloner, men du kan også downloade snesevis af flere med TechSmith Assets for Snagit.

Snagit-skabeloner giver dig mulighed for at oprette en række forskellige slags vejledninger, procesdokumenter, vejledninger og meget mere.

Men lad os sige, at jeg i dette eksempel ønsker at oprette en quick-reference-guide for fem af de mest almindelige værktøjer i Snagit.

Stræk 1. Tag dine skærmbilleder

Først skal du tage alle de skærmbilleder, du har brug for, og lave eventuelle annotationer (pile, tekst osv.), du ønsker at medtage i grafikken.

Stræk 2. Opret din skabelon

Dernæst skal du i Snagit-editoren vælge Opret > Opret billede fra skabelon.

Stræk 3. Vælg en skabelon

Vælg den skabelon, du vil bruge. Der er masser af skabeloner til hurtigreferenceguides at vælge imellem.

I dette eksempel har jeg valgt Basic 5 Steps Landscape. Denne skabelon er beregnet som en trinvis vejledning, men den er også perfekt til dette.

Stræk 4. Tilføj billeder

Fra bakken nederst i Snagit-editoren (bakken Seneste billeder) skal du trække dine skærmbilleder til pladsholderne i skabelonen.

Stræk 5. Ændr størrelsen på billeder

Gør størrelsen på dine skærmbilleder om eller juster dem på anden måde efter behov.

Stræk 6. Tilføj skriftligt indhold

Føj dine beskrivelser til de tilsvarende afsnit i rummet til højre for skabelonen, og tilføj en titel i titelfeltet.

Og du er færdig!

Det tog mig længere tid at skrive trinene ud, end det tog at lave denne lille quick-reference-guide.

Bagefter kan du dele gemme den, dele et link eller printe den ud og lægge den på dit skrivebord.

Fælles typer af quick-reference guides

Der findes en række forskellige typer quick-reference guides, så du skal vide præcis, hvad din målgruppe har brug for, før du opretter en.

Har din målgruppe brug for en hurtig og nem måde at komme i gang med at bruge dit produkts mest grundlæggende funktioner på? Så skal du oprette en quick-start-guide.

Og måske har de brug for en one-stop-reference til at forstå din softwares UX? Hvad med en ordliste over almindelige termer? Eller en oversigt over dit produkts vigtigste funktioner?

Og forestil dig, at dine brugere flytter fra et stykke software til dit. Hvilke oplysninger kan de have brug for for at gøre overgangen lettere? Tænk på ting som forskelle i menustræer, ikoner, funktionsnavne osv.

Alle disse ting (og meget mere) kan opnås med en quick-reference-guide.

Men det er naturligvis alt sammen meget forskellige applikationer. Lær din målgruppes behov og forventninger at kende, og skab derefter det indhold, de har brug for for at få succes.

1. Quick-start guide
   Hjælp dine brugere til hurtigt at komme i gang med dit produkt.
2. Core eller grundlæggende opgaveguides
   Lignende en quick-start guide, men giver et overblik over, hvordan du bruger dit produkts eller din tjenestes mest grundlæggende eller centrale funktioner.
3. Vejledning til mere avancerede funktioner
   Når dine brugere er klar til at tage tingene til et nyt niveau, kan du bruge en quick-reference-guide til at introducere dem til andre funktioner eller egenskaber.
4. Vejledning til produktændringer
   Er din software blevet opdateret for nylig? Brug en quick-reference-guide til at hjælpe dine brugere med at gennemgå ændringerne.
5. Trin-for-trin-vejledning
   Har du en proces, du skal forklare? Vis den!
6. Brugermanual til produkter med begrænsede funktioner eller funktioner
   Hvis dit produkt ikke kræver en stor manual, kan en quick-reference-guide være al den dokumentation, du har brug for.

Væsentlige elementer til at skabe en god quick-reference- eller quick-start-guide

Kend din målgruppe og deres behov

Desto flere af disse blogs jeg skriver, jo mere bliver jeg opmærksom på gennemgående temaer. At skabe det indhold, som dit publikum ønsker (og ikke nødvendigvis det, som du ønsker at fortælle dem), er et af de mest gennemgående.

Som nævnt i denne artikel om, hvordan man skaber mere effektivt indhold til kundeuddannelse, er der en række måder at finde ud af, præcis hvad det er, herunder onlinefora, kundeundersøgelser eller endda fra dit eget tekniske supportpersonale.

Uanset hvordan du får det, vil det at levere indhold, som dine kunder ønsker og har brug for, være med til at sikre succes for dine quick-reference-materialer.

Simplicity is key

Hele pointen med en quick-reference-guide er at gøre information let og let tilgængelig, så sørg for, at den er enkel at forstå.

Brug visuelle elementer

Undgå så vidt muligt store tekstblokke Brug i stedet visuelle elementer som f.eks. skærmbilleder med markup, ikoner eller produktfotos – og kun lige nok tekst til at sikre, at dine pointer er tydelige.

Inddrag kun væsentlige oplysninger

Hold det til en eller to sider. Forsøg ikke at dække alt fra din fulde brugervejledning. Tænk over det – en quick-reference-guide, der har brug for en indholdsfortegnelse, er sandsynligvis ikke så hurtig.

Vælg de vigtigste oplysninger for at udføre en bestemt opgave, eller som på anden måde formidler det, du ønsker at vise. Kog komplekse begreber ned til deres mest grundlæggende form.

Ved, hvad du skal lade være med, og hvad du skal udelade. Husk, at du altid kan oprette en anden quick-reference-guide til at dække andre vigtige emner.

Brug et enkelt og letforståeligt layout

Hvis din quick-reference-guide ikke er visuelt tiltalende og let at følge, vil dine brugere ikke finde den nyttig.

Du behøver ikke at skabe et totalkunstværk for at lave en god quick reference-guide. Nogle gange kan et simpelt skærmbillede annoteret med pile, tekst osv. være nok til at give nogen de oplysninger, de har brug for.

Visuelt indhold

Jeg føler, at jeg ikke kan understrege dette nok: Din quick-reference-guide vil bare ikke være så effektiv, engagerende og nyttig, som den kan være uden gode billeder, ikoner, skærmbilleder eller andre visuelle elementer.

Billeder tiltrækker øjet og hjælper med at skabe ankerpunkter til dit indhold, så dine brugere hurtigt og nemt kan identificere vigtige informationspunkter.

Faktisk har vores undersøgelse af værdien af visuelle elementer vist, at folk lærer bedre med billeder og tekst end med tekst alene.

Du kan lære alt om, hvor værdifuld visuel kommunikation kan være med denne fantastiske infografik.

Og har du nogensinde hørt udtrykket et billede siger mere end tusind ord? Det viser sig, at den bedste måde at vise noget på, er faktisk at vise det.

Et godt billede kan formidle et væld af oplysninger og være med til at reducere teksttætheden i dit indhold og gøre det mere brugervenligt.

Vores venner hos Venngage har nogle flere oplysninger om vigtigheden af visuelt indhold.

Quick-reference guide dos and don’ts

Det er ikke alle quick-reference guides, der vil være lige så enkle som den, jeg har lavet. Nogle vil have brug for mere tekst, andre vil have brug for flere billeder. Nogle vil have brug for mere komplekse layouts. Afhængigt af emnet kan den blive længere.

Der findes en lang række typer af og anvendelsesmuligheder for quick-reference guides, og det ville være umuligt at dække dem alle her. Men der er nogle almindelige dos and don’ts, som er ret universelle: