Handboeken

Een handboek, zoals we het hier definiëren, is een combinatie van het volgende:

• concept informatie
• instructie informatie
• referentie-informatie

allemaal gericht op een specifiek onderwerp voor de behoeften van een specifiek publiek. Als je een cursus technisch schrijven volgt met dit boek, is je handboekproject moet in enige vorm of wijze deze drie elementen. Bovendien moeten deze elementen een natuurlijke, logische "match" zijn voor uw handboekproject.

NotebookLM-geproduceerde infographic van dit hoofdstuk

Handboek Basisprincipes

Concepten. Conceptuele informatie legt uit hoe dingen werken, hoe dingen in elkaar zitten. Voor complexere instructies moet je enkele concepten, theorieën, achtergrond en principes kennen om de instructies uit te voeren. Neem het voorbeeld van de softwarefunctie die je in staat stelt om je eigen kleur te wijzigen of te creëren. Het is gemakkelijk om dit te doen met iets als Photoshop, Illustrator, CorelDraw of Paint Shop Pro— de daadwerkelijke knoppen en schuifregelaars— zijn eenvoudig. Maar begrijpen hoe tint, intensiteit, helderheid, verzadiging, dichtheid, contrast, RGB— dat is moeilijk. Je moet de kleurt theorie voor computers kennen om de kleur te creëren die je nodig hebt.

Overweeg een ander voorbeeld: eenvoudige Linux-bestandssysteemcommando's —ls, cd, cp, mv, pwd. Om deze commando's te gebruiken, moet je begrijpen wat bestanden en mappen zijn, en waarschijnlijk ook wat een besturingssysteem is en wat jokertekens zijn. Je kunt echt niet begrijpen hoe je deze commando's —volg instructies met behulp van hen —tenzij je deze basisconcepten begrijpt.

Instructies. Als je de fundamentele concepten begrijpt, kun je de stapsgewijze procedures intelligent volgen. Instructies zijn die vertrouwde genummerde lijsten die je zorgvuldig door een procedure leiden. Instructies zijn overal, op productverpakkingen, in gebruiksaanwijzingen die bij apparaten en computers komen.

Referentie. De laatste categorie van informatie betreft opzoekinformatie, of snelreferentie-informatie. Als je het bovenstaande voorbeeld van het bestandssysteem volgde, moest je eerst de concepten van bestanden, mappen, jokertekens bestuderen en leren. Dan kon je de instructies volgen en begrijpen over het veranderen van mappen, het kopiëren, verwijderen of verplaatsen van bestanden. Na een tijdje heb je de instructies echter niet meer nodig, maar af en toe heb je speciale vereisten die niet in de instructies worden behandeld of je kunt bepaalde procedures die in de instructies zijn opgenomen niet meer herinneren. Nu is het tijd om basisreferentie-informatie nodig te hebben: je gaat gewoon naar dat gedeelte en kijkt het snel op.

En na verloop van tijd heb je zowel de conceptensectie als de instructiesectie niet meer nodig: je bent zo gewend geraakt aan die procedures, je kent ze uit je hoofd. Maar af en toe vergeet je een klein detail of heb je een speciale taak die je nog nooit eerder hebt gedaan — dat is wanneer je naar de referentieselectie gaat. Je zou waarschijnlijk de concepten- en instructiesecties kunnen afscheuren en weggooien. Alles wat je ooit nodig zult hebben, is de referentieselectie.

Handboek Indeling en Stijl

In een technische schrijfopleiding waarbij dit boek wordt gebruikt, wordt van je verwacht dat je de specifieke richtlijnen voor het gebruik van kopjes, lijsten, mededelingen, graphics, tabellen, documentatie en inleidingen volgt:

Handboekprototype. Vanaf de onderstaande link kun je een dummyversie van het handboek downloaden. Het bevat alle vereiste pagina's in een goed formaat. In dit Word-document zijn alinea- en tekenstijlen opgenomen die je werk gemakkelijker maken en enkele professionele vaardigheden aan je repertoire toevoegen.

Handboek prototype

Inhoudsprototype. De prototype voor de inhoudsopgave is bijzonder nuttig: het geeft je de Word-stijlen om een professioneel ogende inhoudsopgave te maken. Het is moeilijk om de links- en rechts-uitlijnen en de leidende punten goed te krijgen:

Inhoudsopgave prototype

AI Aanwijzingen voor Handboeken

Checklist, die meestal niet gelezen worden, kunnen als bron voor AI-prompts worden gebruikt met enige aanpassing. Kopieer het volgende, plak het in een AI-systeem zoals Google's Gemini, en kijk wat je misschien hebt gemist.

Opmerking: Alle verwijzingen naar de inhoud, het formaat en de stijl van techdocs of zijn componenten zijn te vinden in de online technisch schrijfboek.

komt binnenkort!

Ik zou uw gedachten, reacties, kritiek op dit hoofdstuk waarderen: je antwoord—David McMurrey.