Kies ingangen vanuit de handleiding
Markeer tijdens het proeflezen welke termen nodig zijn om een stap uit te voeren. Neem alleen termen op die in de handleiding voorkomen en voor de beoogde lezer uitleg vragen. Maak niet automatisch een woordenboek van elk zelfstandig naamwoord. Een term die slechts één keer wordt gebruikt, kun je soms beter op die plaats kort toelichten.
Kies per begrip één voorkeursnaam. Gebruikt het scherm concept, noem dezelfde toestand in de handleiding dan niet afwisselend kladversie, voorlopig bestand en concept zonder die relatie uit te leggen. Maak een verwijzing bij een noodzakelijke alternatieve naam.
Geef elke ingang dezelfde bruikbare onderdelen
Noteer de term, de betekenis binnen deze handleiding en de stap waar de lezer ermee werkt. Bij een systeem met statussen beschrijf je wat wel en niet mogelijk is. Zo kan een definitie direct helpen bij een handeling. Schrijf geen cirkeldefinitie waarin alleen hetzelfde woord terugkomt.
Een vaste vorm helpt bij vergelijken: Concept — een opgeslagen bericht dat nog niet is gepubliceerd. Je kunt het in stap 3 verder bewerken. De uitleg zegt iets over deze toepassing; zij beweert niet dat ieder programma het woord exact zo gebruikt.
Orden, verwijs en onderhoud
Een alfabetische lijst is bruikbaar wanneer de lezer de term al heeft gezien. Groeperen per taak kan passen bij een korte handleiding, mits de groepen duidelijk benoemd zijn. Zet synoniemen niet als twee losstaande definities naast elkaar: laat een alternatieve ingang naar de voorkeursnaam verwijzen.
Controleer bij iedere wijziging aan de handleiding ook de lijst. Bestaat de genoemde stap nog? Gebruikt het scherm nog dezelfde naam? Laat een proeflezer een term opzoeken en daarna de bijbehorende stap uitvoeren. Voor het begrijpen van vaktaal zelf kun je verder naar de bestaande vaktaalles.
Voorbeelden met uitleg
- Concept — opgeslagen, nog niet gepubliceerd; bewerken kan in stap 3.
Een status wordt gekoppeld aan een concrete handeling. - Kladversie — zie Concept.
Een alternatieve naam verwijst naar één voorkeursingang. - Publiceren — het bericht publiceren.
Dit is een cirkeldefinitie. Beschrijf wie het bericht daarna kan zien in deze toepassing.
Probeer het zelf
- Welke van tien gemarkeerde termen neem je op als er vier nodig zijn voor de taak en de overige zes alledaagse woorden zijn?
- Maak een ingang voor Archief: oudere, bewaarde berichten staan daar en zijn in stap 6 terug te vinden.
- Wat verander je als stap 6 in de handleiding wordt verplaatst naar stap 8?
- Waarom zijn twee verschillende definities bij Concept en Kladversie riskant als ze dezelfde status bedoelen?
Bekijk de antwoorden en uitleg
- Begin met de vier taakgebonden termen die uitleg nodig hebben. Toets die keuze bij de beoogde lezer; tien markeringen betekenen niet automatisch tien nuttige ingangen.
- Bijvoorbeeld: Archief — overzicht van oudere, bewaarde berichten. Open dit overzicht in stap 6 om een bericht terug te vinden.
- Pas de verwijzing in de begrippenlijst aan naar stap 8 en controleer of de beschreven handeling nog klopt.
- De lezer kan gaan denken dat er twee verschillende statussen bestaan. Kies één definitie en gebruik voor de andere naam een zie-verwijzing.