Riktlinjer för att skapa lathund
Användare kan använda lathundar och sammansatta lathundar till att uppnå ett mål genom att slutföra en följd steg. I de här riktlinjerna diskuteras när lathundar bör användas och hur du skapar en lathund på bästa sätt.
När är det lämpligt att använda lathundar?
Lathundar är mycket lämpliga för uppgifter som består av steg som leder till ett konkret mål, till exempel att skapa en enkel tillämpning. Målet måste vara väldefinierat så att användaren kan se när alla steg i lathunden har slutförts utan problem. Självstudiekurser är ofta lämpliga som lathundar. I en självstudiekurs är målet att lära sig att utföra en specifik uppgift. Lathundar innehåller vanligen upp till 10 steg och kan slutföras på en halvtimme eller mindre.
För större uppgifter bör du överväga att använda en sammansatt lathund.
När är det lämpligt att använda sammansatta lathundar?
Sammansatta lathundar används till att tillhandahålla riktlinjer för uppgifter som är för stora för att beskriva i en enkel lathund eller för uppgifter med flera mål. En sammansatt lathund kan användas till att beskriva en följd av uppgifter där varje uppgift bygger vidare på den föregående uppgiften.
När är det inte lämpligt att använda lathundar?
Lathundar fungerar bäst när det går att lösa ett problem genom följa några enkla steg. Lathundar kan inte användas i stället för ett hjälpsystem där det är möjligt att skapa HTML-sidor med avancerad grafik och direktåtkomst till information med hjälp av sökfunktioner och hyperlänkar. Lathundar är inte ämnade för uppgifter där det krävs att en stor mängd text anges av användaren.
Riktlinjer för att skapa en lathund
- Välj ett kort och självförklarande namn.
- Använd länkar till hjälpsystemet i lathundsuppgifter så långt det är möjligt för att skapa bakgrund eller tillhandahålla mer detaljerad information
- Överväg att göra om lathunden till en sammansatt lathund om den innehåller fler än tio steg.
- Använd kommandon där det är möjligt för enkla och tråkiga uppgifter, till exempel för att öppna perspektiv, öppna resurser och köra guider. Ge även en beskrivning av hur användaren kan uppnå samma resultat utan att använda kommandot.
- Se till att det går att hoppa över kommandon om användaren bestämmer sig för att gå igenom stegen manuellt.
- Ange dialog="true" för steg där dialogrutor öppnas. Det innebär att lathunden öppnas i "fältet" till höger i de flesta dialogrutor.
- Ordna stegen på ett sådant sätt att användaren med jämna mellanrum kan se att uppgifter slutförs som de ska. En lathund som innebär att ett antal olika ändringar av Java-källkod görs och att en tillämpning sedan startas kan skrivas om så att tillämpningen startas efter varje källändring.
- Gör det tydligt för användaren varför han eller hon ska utföra varje steg.
- I stället för att beskriva flera sätt att utföra ett steg väljer du det sätt som är enklast och enklast att beskriva.
- Använd radbrytningsmärkord (<br/>) till att förbättra läsbarheten.
- Underobjekt kan användas till att dela upp steg i flera mindre steg.
- Underobjekt krävs inte i alla lathundar.
- Börja etikettext för underobjekt med åtgärdsord, till exempel "Ange", "Expandera",
"Välj" osv.
- Markera tydligt vad som är gränssnittstext för underobjektsetiketter med citattecken så att användare kan skilja på anvisningstext och gränssnittstext som de måste hitta och arbeta med.
- Varje underobjekt ansvarar för en atomär uppgift, till exempel inmatning av ett värde.
- Lägg alltid till ett <onCompletion>-element till det sista steget i en lathund.
- Testa lathundar med olika storlek för lathundsvyn.
- Testa lathundar med felloggsvyn öppen så att du kan se om varningar visas i loggfilen.
Riktlinjer för att skapa en sammansatt lathund
- En sammansatt lathund bör innehålla uppgifter som är relaterade till ett gemensamt tema.
- Varje uppgift i en sammansatt lathund bör ha ett väldefinierat mål.
- Använd <onCompletion>-element så att användaren kan se att uppgifter slutförts som de ska.
- Uppgiftsnamn bör vara korta och koncisa.
- Komplexa problem kan lösas genom användning av uppgifter som bygger vidare på föregående uppgifter.
- Använd skip="true" om en uppgift är valfri.
- För konsekvensens skull kontrollerar du att introduktionen och namnet för den enkla lathunden överensstämmer med den introduktion och det namn som angetts i den sammansatta lathunden.
- För uppgiftsbeskrivningar anger du vad som är gränssnittstext med fetstil.
- Sekvenser bör endast användas när det är viktigt att uppgifter utförs i en viss ordningsföljd.
Relaterade länkar
Arbeta med lathundar
Arbeta med sammansatta lathundar
Enkla lathundar
Sammansatta lathundar