het Schrijven van stap-voor-stap instructies

  • 01/19/2018
  • 2 minuten om te lezen
    • p
    • m
    • m
    • c
    • v
    • +1

Volg de onderstaande richtlijnen om u te helpen bij het maken van duidelijke, gemakkelijk te volgen instructies,of je bent het schrijven van eenvoudige-stap procedures of complexprocedures die bestaan uit meerdere stap.

zie ook
tekst opmaken in instructies
interpunctie opmaak

complexe procedures

complexe instructies bestaan vaak uit meerdere stappen die zijn geformatteerd als geanummerde lijst. Voor procedures in meerdere stappen in genummerde lijsten:

  • formatteer procedures consistent zodat klanten ze gemakkelijk kunnen vinden door te scannen.

  • overweeg om een kop te gebruiken om klanten te helpen snel instructies te vinden. Gebruik de rubriek om klanten te vertellen wat de instructies hen zullen helpen doen.
    voorbeelden
    Om een account toe te voegen
    voeg een account toe

    Kies een fraseerstijl voor de kopteksten en schrijf ze allemaal op dezelfde manier (in parallelle structuur).

  • Gebruik een aparte genummerde vermelding voor elke stap. Het is OK om korte stappen die zich op dezelfde plaats in de gebruikersinterface te combineren.

  • neem meestal acties op die een stap voltooien, zoals OK of Apply knoppen.

  • gebruik volledige zinnen.

  • gebruik gebiedende werkwoordsvormen. In instructies, klanten willen echt dat je om hen te vertellen wat te doen.

  • gebruik consistente zinsstructuren. Gebruik bijvoorbeeld altijd een zin wanneer u de klant moet vertellen waar hij moet beginnen. De rest van de tijd, begin elke zin met een werkwoord.
    voorbeelden
    Op het lint, ga naar het tabblad Design.
    Foto ‘ s openen.
    voor uitlijning, kies links.

  • geef het eerste woord in elke stap een hoofdletter.

  • Gebruik een periode na elke stap.
    uitzondering
    Wanneer klanten worden geïnstrueerd om invoer te typen die geen einde interpunctie bevat, gebruik dan geen punt. Probeer de tekst te formatteren zodat de invoer van de gebruiker op een nieuwe regel verschijnt.

  • beperk een procedure tot zeven stappen, en bij voorkeur minder. Probeer alle stappen op hetzelfde scherm te passen.
    voorbeelden

    om een groep tiles

    1. aan te maken op het startscherm, selecteert u de tiles die u wilt groeperen.
    2. sleep ze naar een open ruimte. Wanneer er een grijze balk achter hen verschijnt, laat de tegels los om de nieuwe groep te maken.

    om sprints in te plannen

    1. in de weergave Achterlogbestanden, selecteert u de eerste sprint onder Current. Of open je sprint backlog vanuit de volgende URL:https://AccountName/DefaultCollection/TeamProjectName/_backlogs/iteration
      verschillende voorgedefinieerde sprints staan vermeld onder Huidige en toekomstige. Werkelijke sprint titels variëren op basis van het proces sjabloon gebruikt om uw team project te maken. Echter, kalender data zijn niet toegewezen.
    2. om de kalenderdata in te stellen, selecteert u de eerste sprint onder Current en selecteert u datums.

Single-step procedures

Als u een consistent formaat gebruikt voor stapsgewijze instructies,gebruik dan hetzelfde formaat voor instructies in één stap, maar vervang het nummer door een opsommingsteken.
voorbeeld
Om een groep tegels

  • op het startscherm te verplaatsen, uitzoomen en de groep slepen waar u wilt.

Tips voor het schrijven van stappen

zorg ervoor dat de klant weet waar de actie moet plaatsvinden voordat u de actie beschrijft.

  • als de instructie verschijnt in dezelfde gebruikersinterface waar de actie plaatsvindt, is het meestal niet nodig om locatiegegevens op te geven.

  • Als u ervoor wilt zorgen dat de klant op de juiste plaats begint, geef dan een korte zin aan het begin van de stap.
    voorbeeld
    op het tabblad Design, selecteer koprij.

  • als er kans op verwarring is, geef dan een inleidende stap.
    voorbeeld
    Op het lint, ga naar het tabblad Design.

eenvoudige instructies met haakse haken

verkort eenvoudige reeksen met haakse haken. Neem een Pace voor en na elke beugel, en maak de brackets niet vet.

voorbeeld
selecteer Accounts > Overige accounts > een account toevoegen.

Toegankelijkheidstip schermlezers kunnen haakjes overslaan en instructies lezen zoals Menu > Ga naar > mappen als Menu Ga naar mappen, wat klanten in verwarring kan brengen. Neem contact op met een toegankelijkheidsexpert voordat u deze aanpak gebruikt.

Geef een antwoord

Het e-mailadres wordt niet gepubliceerd.