Stap 1: Plan het Document
Het eerste ding om te doen met elk geschreven document is te plannen van het materiaal om te worden opgenomen. Zelfs als niets in het oorspronkelijke plan wordt gebruikt, is het belangrijk om te beginnen na te denken over het document als geheel vóór werken aan individuele stukken. Het is handig om de blik op andere technische beschrijvingen om een greep op de "feel" van hoe een goede eruit ziet.
- Bij het ontwikkelen van een plan voor uw technische beschrijving, kunt u de volgende vragen:
- Wie zal dit document worden gebruikt?
- Wat zal moeten worden opgenomen in dit document?
- Wanneer zal dit document moeten worden gebruikt?
- Waar zal dit document worden gebruikt?
- Waarom is dit document nodig?
2. het segmenteren van het onderwerp in verschillende logische secties. Voorbeelden zijn:
- Onderdelen - segmentering van het onderwerp in zijn verschillende onderdelen of functies kan is de meest ongecompliceerde manier, en erg logisch voor de lezer.
- Stappen - als een ding gebeuren om het proces voort te zetten moet, stappen zou de ideale manier om te scheiden van de beschrijving.
- Opmerking: Het doel van dit document is om te leren van de lezer hoe om te doen een proces, misschien het niet als een technische beschrijving maar instructies!
3. plan op de afbeeldingen of logo's die moeten worden gebruikt.
- Grafieken, afbeeldingen en grafieken zijn genre definiëren kenmerken van technische beschrijvingen! Ze worden gebruikt te breken tekst, en om belangrijke informatie aan de lezer.
- Een goede afbeelding kan staan op eigen en een compleet verhaal vertellen. Het doel moet zijn voor de lezer niet nodig om te scannen door leden van de afbeelding relevant te zijn.
- Let op: Als deze technische beschrijving zal worden gebruikt in een commerciële omgeving, moet u alleen het opnemen van afbeeldingen die het bedrijf het recht om te heeft!