Hoe je een handleiding vanuit het niets kunt schrijven

Het schrijven van een handleiding over een belangrijke functie op het werk toont je vaardigheden aan je meerderen. Toon je vaardigheden om zelf een project te voltooien.

2

Bepaal voor welk type doelgroep u schrijft.

3

Bepaal precies waar je het over gaat hebben in je handleiding.

4

Bepaal een logische volgorde om uw handleiding te presenteren. Dit verwijst niet naar een logische volgorde van acties. Sommige onderwerpen moeten mogelijk eerst worden gepresenteerd. Activiteiten die in alle delen van de handleiding moeten worden opgenomen, moeten eerst worden uitgelegd. Als je vindt dat de lezer al vaardigheden moet hebben om de taak te voltooien, overweeg dan om de taak in een bijlage te beschrijven.

5

Als de handleiding terminologie of technisch jargon gaat gebruiken, bereid dan een woordenlijst voor. Als u denkt dat het onwaarschijnlijk is dat de lezer de terminologie kent, plaats dan de woordenlijst onmiddellijk na de inhoudsopgave. Werk de woordenlijst bij terwijl u de handleiding schrijft

6

Bepaal welke zaken je nodig hebt om een ​​dieper onderzoek te doen. Een verkeerde handleiding is een onbruikbare handleiding. Voltooi uw voorlopig onderzoek voordat u uw handleiding start.

7

Bepaal de organisatie van elke sectie die u gaat schrijven.

8

Organiseer elke sectie en subsectie in een logische volgorde, waardoor de amplitude van het onderwerp afneemt.

9

Begin met schrijven! Gebruik uw organisatie als richtlijn, maar pas deze aan als deze niet werkt.

• Wijzig illustraties om suggesties te geven om aan te geven waarnaar de gebruiker op zoek is.
  
• Voorbeeld 1: (kijkend naar een lijst in de lijst) Een schrijver zou een probleem met het nummer "13" verbinden.
  
• Voorbeeld 2: (Classificeren) Een schrijver verlengt een regel tekst die niet in orde was.

10

Plagiaat het schrijven van iemand anders niet! Houd een lijst met referenties en / of citaten bij uit boeken, handleidingen en mensen die u de informatie hebben gegeven.

11

Voeg toepasselijke illustraties toe. Pas ze aan in het document. Wees niet bang om lege ruimte te gebruiken.

12

Repareer, corrigeer en corrigeer opnieuw. De correctie moet continu zijn. Maak aantekeningen van fouten of weglatingen. Corrigeer ze. Maak aantekeningen van passages die "anderen" misschien verwarrend vinden. Herschrijf de passage om het lezen te vergemakkelijken. Laat een aantal mensen uw handleiding lezen om het best mogelijke resultaat te garanderen.

• Waarom moet een newbie het corrigeren? De handleiding moet begrijpelijk zijn voor een minimum kennisniveau dat u verwacht te lezen.