Hoe om `n handleiding van nuuts af te skryf

Die skryf van `n handleiding oor `n belangrike funksie by die werk demonstreer jou vaardighede aan jou meerderes. Wys jou vaardighede om self `n projek te voltooi.

2

Besluit watter tipe gehoor jy skryf.

3

Definieer presies waaroor u in u handleiding gaan praat.

4

Besluit op `n logiese volgorde om u handleiding aan te bied. Dit verwys nie na `n logiese volgorde van aksies nie. Sommige onderwerpe moet dalk eers aangebied word. Aktiwiteite wat in alle dele van die handleiding ingesluit moet word, moet eers verduidelik word. As jy voel dat die leser reeds vaardighede moet hê om die taak te voltooi, oorweeg dit om die taak in `n bylaag te beskryf.

5

As die handleiding terminologie of tegniese jargon gaan gebruik, maak `n woordelys voor. As jy dink dit is onwaarskynlik dat die leser die terminologie sal ken, plaas die woordelys onmiddellik na die inhoudsopgawe. Werk die woordelys op terwyl jy die handleiding skryf

6

Besluit oor watter kwessies u `n dieper ondersoek moet doen. `N Onjuiste handleiding is `n onbruikbare handleiding. Voltooi u voorlopige ondersoek voordat u u handleiding begin.

7

Besluit oor die organisasie van elke afdeling wat jy gaan skryf.

8

Organiseer elke afdeling en onderafdeling in `n logiese volgorde en verminder die amplitude van die onderwerp.

9

Begin skryf! Gebruik jou organisasie as `n gids, maar verander dit as dit nie werk nie.

• Verander illustrasies om voorstelle te gee om aan te dui waarvoor die gebruiker soek.
  
• Voorbeeld 1: (Kyk na `n lys met lys) `n Skrywer sal `n probleem met die nommer "13" koppel.
  
• Voorbeeld 2: (Klassifiseer) `n Skrywer verleng `n lyn van teks wat buite werking was.

10

Moenie iemand anders se skryfwerk plagiaat nie! Hou `n gelysde gedeelte van verwysings en / of aanhalings uit boeke, handleidings en mense wat jou die inligting gegee het.

11

Voeg gepaste illustrasies by. Pas hulle in die dokument aan. Moenie bang wees om wit spasie te gebruik nie.

12

Herstel, korrigeer en verbeter weer. Die regstelling moet deurlopend wees. Maak notas van foute of weglatings. Korrigeer hulle. Maak aantekeninge van gedeeltes wat "ander" verwarrend kan vind. Herskryf die gedeelte om dit makliker te maak om te lees. Het `n verskeidenheid mense wat jou handleiding lees om die beste moontlike uitslag te verseker.

• Hoekom het `n newbie dit reggemaak? Die handleiding moet verstaanbaar wees vir `n minimum vlak van kennis wat u verwag om te lees.