Technische schrijvers maken verschillende soorten documentatie, bijvoorbeeld gebruikershandleidingen, API-documentatie, ‘How to’-gidsen, enzovoort. Ik heb een artikel geschreven over hoe je een gebruikershandleiding schrijft, dus vandaag vertel ik je over het maken van een ‘How to’-gids.
Als je de opdracht krijgt om een gids te maken, moet je eerste stap het plannen zijn. Dit is wat u moet doen:
Begrijp uw doelgroep
Wanneer u begint met het schrijven van uw gids, moet u duidelijk begrijpen wie uw doelgroep is. Wat is hun leeftijd, wat is hun achtergrond, enzovoort. Dit zal de stijl van uw ‘How to’-gids op het meest fundamentele niveau bepalen – de complexiteit van de gebruikte taal, het aantal termen en vele andere kenmerken.
Onderzoek naar het proces
Ik raad u aan te lezen over de ervaringen van anderen met het schrijven van ‘how-to’-gidsen. Het zal u helpen een duidelijk beeld te krijgen van het toekomstige werk, en u kunt de aanpak van anderen integreren in uw werkproces. Ik heb bijvoorbeeld geschreven over het technisch schrijfproces van Amrute Ranade, u kunt het artikel hier lezen: ‘Great Technical Writing Process’. U kunt deze methode dus ook gebruiken om uw technisch schrijven te vergemakkelijken.
Verzamel nuttig materiaal
Voordat u begint te schrijven, verzamelt u materiaal en informatie die u zullen helpen bij het schrijven van een ‘how-to’-gids. Dat kan aanvullende informatie over een product zijn, andere ‘how-to’-gidsen over soortgelijke producten of iets anders.
Schrijf uw ‘how-to’-gids
Maak allereerst een plan – het zal gemakkelijker zijn om een gids te schrijven als u het visualiseert. Na al deze voorbereidingen is het de hoogste tijd om te beginnen met schrijven. Bij het maken van een gids moet u de volgende tips in gedachten houden:
- Schrijf in gewoon Engels om dezelfde taal te spreken als uw lezers.
- Uw taalgebruik moet altijd beknopt zijn (bijv, ‘Selecteer de optie’ in plaats van ‘U moet de optie selecteren’).
- Creëer genummerde lijsten om stappen te structureren als een gebruiker ze moet voltooien
- Voeg visuele inhoud toe, zoals foto’s, schermafbeeldingen en diagrammen.
- Breek inhoud op in hoofdstukken, maar schrijf ze duidelijk
- Als je grappen wilt gebruiken, wees dan voorzichtig: mensen zullen je misschien niet begrijpen
- Voeg mini-TOC’s toe om grote onderwerpen leesbaarder te maken.
De meest essentiële tip is de volgende – spel- en grammaticafouten zijn onaanvaardbaar in de documentatie, dus controleer je gids grondig. Hier is een lijst van Top Gratis Grammatica Checkers. U kunt ook iemand anders vragen om voor u te proeflezen, of uw eigen stappen in omgekeerde volgorde lezen om er zeker van te zijn dat uw schrijven duidelijk en eenvoudig is. Hier zijn nog een paar andere bronnen om goede documentatie te schrijven:
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
Natuurlijk is dat nog niet alles wat je moet weten over het schrijven van ‘How to’ gidsen, maar deze tips zijn naar mijn mening het meest essentieel. Ik hoop dat je er wat aan hebt.
Veel succes met je schrijfgidsen!