Richtlijnen voor auteurs van hulpbladen
Hulpbladen en samengestelde hulpbladen dienen om gebruikers te helpen een bepaald doel te bereiken
door een reeks stappen uit te voeren. In deze richtlijnen wordt behandeld in welke gevallen
hulpbladen moeten worden gebruikt en wat de beste manier is om ze te schrijven.
Wanneer maakt u hulpbladen
Hulpbladen zijn zeer geschikt voor taken die bestaan uit meerdere stappen met een
tastbaar einddoel, zoals het bouwen van een eenvoudige toepassing. Het doel moet
duidelijk zijn omschreven, zodat de gebruiker een zichtbaar resultaat heeft als alle
stappen in het hulpblad zijn voltooid. Hulpbladen zijn vaak bij uitstek geschikt voor zelfstudies
omdat die als doel hebben de gebruiker te leren een bepaalde taak uit te voeren. Hulpbladen
bevatten gewoonlijk hooguit 10 stappen en kunnen binnen een half uur worden voltooid.
Voor omvangrijke taken kunt u beter een samengesteld hulpblad maken.
Wanneer maakt u samengestelde hulpbladen
Samengestelde hulpbladen worden gebruikt om de gebruiker te begeleiden bij het uitvoeren
van een taak die te omvangrijk is om in één hulpblad op te nemen of meerdere doelen
heeft. Een samengesteld hulpblad kan worden gebruikt om een reeks opeenvolgende taken
te beschrijven, waarbij elke taak is gebaseerd op de vorige.
Wanneer gebruikt u geen hulpbladen
Hulpbladen dienen bij voorkeur te worden gebruikt voor problemen die kunnen worden opgelost
door een reeks eenvoudige stappen uit te voeren. Hulpbladen vormen geen vervanging voor het
Help-systeem, dat kan worden voorzien van HTML-pagina's met fraaie afbeeldingen en
rechtstreeks toegang biedt tot allerlei informatie via zoekfuncties en hyperlinks.
Hulpbladen zijn niet bedoeld voor taken waarbij de gebruiker een grote hoeveelheid
tekst moet invoeren.
Richtlijnen voor het maken van een hulpblad
- Kies een korte en bondige titel.
- Gebruik waar mogelijk in het hulpblad links naar het Help-systeem zodat de
gebruiker achtergrondinformatie of uitgebreidere informatie kan opvragen.
- Overweeg of u het hulpblad niet beter kunt herschrijven als samengesteld hulpblad
als het hulpblad meer dan 10 stappen omvat.
- Gebruik waar mogelijk opdrachten om eenvoudige veelvoorkomende taken (zoals het
openen van perspectieven en resources of het starten van wizards) uit te voeren. Geef ook
een beschrijving hoe hetzelfde effect kan worden bereikt zonder de betreffende opdracht
te gebruiken.
- Zorg ervoor dat opdrachten kunnen worden overgeslagen als de gebruiker de betreffende stappen
handmatig wil uitvoeren.
- Geef dialog="true" op voor stappen waarbij dialoogvensters moeten worden geopend.
Hierdoor wordt het hulpblad geopend in een "hulpvak" rechts van de meeste dialoogvensters.
- Deel de stappen zo in dat de gebruiker regelmatig tastbare resultaten
ziet. Een hulpblad waarmee diverse wijzigingen in de Java-broncode worden aangebracht
en vervolgens een toepassing wordt gestart, kan bijvoorbeeld zo worden herschreven dat de
toepassing na elke broncodewijziging wordt gestart.
- Zorg ervoor dat de gebruiker goed begrijpt waarom elke stap wordt uitgevoerd.
- Beschrijf niet meerdere manieren om een stap uit te voeren, maar beschrijf
alleen de eenvoudigste manier die zo min mogelijk instructies vergt.
- Gebruik break-tags (<br/>) om de leesbaarheid te verbeteren.
- Gebruik subitems om lange stappen onder te verdelen in een aantal kortere stappen.
- Niet alle hulpbladen vereisen subitems.
- Begin subitems met een werkwoord in de gebiedende wijs, bijvoorbeeld "Typ", "Klik op",
"Selecteer", enzovoort.
- Geef verwijzingen naar de software duidelijk aan met aanhalingstekens zodat
de gebruikers deze gemakkelijk kunnen onderscheiden van de overige tekst.
- Zorg ervoor dat elk subitem één kerntaak vertegenwoordigt, bijvoorbeeld het invoeren van een waarde.
- Voeg altijd een <onCompletion>-element toe aan de laatste stap van een hulpblad.
- Test hulpbladen bij verschillende afmetingen van de hulpbladview.
- Test hulpbladen terwijl het foutenlogboek geopend is, zodat u kunt zien of er waarschuwingen naar het logboek worden weggeschreven.
Richtlijnen voor het maken van een samengesteld hulpblad
- Een samengesteld hulpblad moet taken bevatten die gerelateerd zijn aan een gemeenschappelijk thema.
- Elke taak in een samengesteld hulpblad moet een duidelijk omschreven doel hebben.
- Gebruik <onCompletion>-elementen aan te geven wanneer een taak naar behoren is uitgevoerd.
- Taaknamen moeten kort en bondig zijn.
- Ingewikkelde problemen kunnen stapsgewijs worden opgelost met behulp van taken die voortborduren op de voorgaande taken.
- Gebruik skip="true" voor optionele taken.
- Zorg ervoor dat de inleiding en naam van het eenvoudige hulpblad overeenkomen met die in het samengestelde hulpblad.
- Gebruik vetcodes voor verwijzingen naar de software in taakbeschrijvingen.
- Gebruik alleen taakreeksen als het noodzakelijk (verplicht) is de taken in een bepaalde volgorde uit te voeren.
Verwante onderwerpen
Werken met hulpbladen
Werken met samengestelde hulpbladen
Eenvoudige hulpbladen
Samengestelde hulpbladen