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 specifieke doelgroep. Als je een technische schrijf cursus volgt met dit boek, is je handboekproject moet in een of andere vorm of manier elk van deze drie elementen opnemen. Bovendien moeten deze elementen een natuurlijke, logische "aanpassing" zijn voor uw handboekproject.

Zorg ervoor dat je de voorbeelden.

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, achtergrond, principes kennen om de instructies uit te voeren. Overweeg het voorbeeld van de softwarefunctie die je in staat stelt om je eigen kleur aan te passen of te creëren. Het gebruik van iets als Photoshop, Illustrator, CorelDraw of Paint Shop Pro om dit—de feitelijke knoppen en schuifregelaars—is eenvoudig. Maar begrijpen hoe tint, intensiteit, helderheid, verzadiging, dichtheid, contrast, RGB—dat is moeilijk. Je moet de kleurentheorie van 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, evenals wildcards. Je kunt echt niet begrijpen hoe je deze commando's—volgen instructies met behulp hiervan—tenzij je deze basisconcepten begrijpt.

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

Referentie. De laatste categorie van informatie betreft opzoekinformatie, of snelle referentie-informatie. Als je het voorbeeld van het bestandssysteem hierboven hebt gevolgd, moest je eerst de concepten van bestanden, mappen en wildcards bestuderen en leren. Daarna kon je de instructies over het veranderen van mappen, het kopiëren, verwijderen of verplaatsen van bestanden volgen en begrijpen. Na een tijdje heb je echter de instructies niet meer nodig, maar zo nu en dan heb je speciale vereisten die niet in de instructies zijn behandeld of je kunt je bepaalde procedures die in de instructies zijn behandeld niet herinneren. Nu is het tijd voor basisreferentie-informatie: je gaat gewoon naar dat gedeelte en kijkt het snel op.

En naarmate er meer tijd verstrijkt, heb je zowel de sectie met concepten als de sectie met instructies niet meer nodig: je hebt je zo gewent 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 — dan ga je naar de referentiesectie. Je kunt waarschijnlijk de secties met concepten en instructies afscheuren en weggooien. Alles wat je ooit nodig zult hebben is de referentiesectie.

Handboekformaat en Stijl

In een cursus technisch schrijven met dit boek, wordt van je verwacht dat je de specifieke richtlijnen voor het gebruik van koppen, lijsten, mededelingen, graphics, tabellen, documentatie en inleidingen volgt:

Handboek prototype. Van de onderstaande link kunt u een dummyversie van het handboek downloaden. Het bevat alle vereiste pagina's in goed formaat. In dit Word-document zijn alinea- en tekenstijlen opgenomen die uw werk eenvoudiger maken en enkele professionele vaardigheden aan uw repertoire toevoegen.

Handboekprototype

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 rechtse uitlijningen en de leiderspunten goed te krijgen:

Inhoudsopgave prototype

Handboek Voorbeelden

Hier zijn enkele links naar voorbeeldhandboeken. Wees ervan bewust dat er enkele problemen zijn in de voorbeelden, de meeste problemen heb ik van opmerkingen voorzien. Sommige hiervan zijn grensgevallen voor handboeken. Wat voor mij een handboek maakt, is de aanwezigheid van conceptuele discussie, instructies en referentie-informatie.

Zorg ervoor dat je de voorbeelden.

AI Aanwijzingen voor Handboeken

Checklists, die doorgaans ongelezen blijven, kunnen als bron voor AI-prompts worden gebruikt met enkele aanpassingen. Kopieer het volgende, plak het in een AI-systeem zoals Google's Gemini, en kijk wat je mogelijk hebt gemist.

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

komt snel!

Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk waarderen: uw reactie—David McMurrey.