Inhoud controleren
Een van de belangrijkste manieren waarop je een ruw ontwerp kunt beoordelen, is door de inhoud te controleren—hoe voor de hand liggend is dat! Alle goede overgangen, goede organisatie en duidelijke zinsstructuur ter wereld kunnen een techdoc niet helpen die niet de juiste inhoud heeft. De inhoud van een techdoc kan "verkeerd" zijn op verschillende manieren:
- Het kan helemaal ontbreken: stel je voor dat iemand een rapport schreef over "virtuele gemeenschappen" maar nooit de moeite nam om te definiëren wat die term betekent. Het zou moeilijk zijn om vanaf het begin van dat rapport verder te gaan.
- Het is er, maar niet genoeg: neem hetzelfde voorbeeld — stel je voor dat de schrijver alleen een aantal vage uitspraken deed over virtuele gemeenschappen. Wat nodig was, was minstens een paragraaf over het onderwerp, zo niet een volledige sectie van 3 of 4 pagina's.
- Het is er wel, maar op het verkeerde niveau voor het publiek: Het is ook mogelijk om informatie op het verkeerde niveau te presenteren in termen van kennis, achtergrond of behoeften van de lezers. Stel je voor dat de schrijver een sectie van 3 pagina's over gegevenscaching heeft opgenomen, maar geschreven voor de productontwikkelaar (een "expert" publiek) terwijl het rapport eigenlijk bedoeld was voor niet-specialisten.
Als je een gevoel kunt krijgen van hoe informatie inadequate is in een conceptverslag, ben je goed op weg om te weten wat je specifiek moet doen om te herzien. Een nuttig brainstorminstrument is om in termen van te denken typen van inhoud.
Gebruik de vragen die zijn gegeven in documentinhoud om je ruwe versie te bekijken voor soorten informatie die je kunt toevoegen of wijzigen.
Controleer de structuur van je inhoud
Er zijn twee manieren om naar de organisatie van informatie in een document te kijken:
- één, behandeld in de volgende sectie, omvat het bekijken van de volgorde van stukken informatie en zien of ze in de juiste volgorde staan.
- Een ander heeft te maken met niveaus van informatie. Je kunt naar de zinnen of paragrafen in een ruwe versie kijken en zien dat sommige zinnen een diepere discussie over het onderwerp aangaan dan andere. Andere zinnen fungeren als het raamwerk waarop die zinnen van een dieper niveau afhankelijk zijn. Door op deze manier naar de structuur te kijken, controleer je niet alleen de organisatie, maar krijg je ook veel goede ideeën over hoe je de inhoud van de tekst kunt verbeteren.
Veel gedetailleerdere uitleg wordt gegeven op coördinatie en subordinaat in alinea's.
Controleer organisatie
Als je de juiste inhoud in een rapport hebt, heb je in ieder geval alle "juiste spullen" beschikbaar voor lezers. Het kan echter nog steeds niet goed georganiseerd zijn—zoals wanneer je net bent verhuisd en alles een rommel is of nog in dozen zit. Je hebt twee essentiële vaardigheden nodig om de organisatie van een ruwe versie te beoordelen:
- Identificeer het onderwerp van stukken informatie op verschillende niveaus. Om de organisatie van een reeks alinea's te beoordelen, begin je met het bedenken van een woord of een frase om het onderwerp van elke alinea te identificeren—met andere woorden, krijg grip op elk van hen. Daarna neem je afstand van die woorden of zinnen en overweeg je of ze in de juiste volgorde staan. Dat is echter slechts één niveau. Je kunt ook kijken binnen een individuele alinea voor zijn organisatie. In dit geval identificeer je het onderwerp van elke zin en overweeg je de volgorde van die zinnen.
- Kies de beste volgorde voor stukken informatie. Zodra je het onderwerp van elk van de informatiebrokken weet (op welk niveau je ook onderzoekt), kun je beslissen of ze in de juiste volgorde staan. Deze beslissing omvat het kennen van de veelvoorkomende volgordepatronen; hier zijn enkele voorbeelden:
- Algemene → specifiek: Een gangbare manier om te organiseren is om stukken inhoud van algemeen naar specifiek te rangschikken. Bijvoorbeeld, het definiëren alle Zonnecollectoren is een algemenere discussie dan het bespreken van de verschillende types zonnecollectoren. En het beschrijven van de werking van een specifiek type zonnecollector is zelfs nog minder algemeen. Dit patroon wordt hier geïllustreerd:
Herziening met het algemeen-naar-specifiek organisatiepatroon. het is een meer natuurlijke voortgang om te beginnen met het definiëren van wat alle zonnecollectoren doen, en vervolgens over te gaan op hun verschillende types. - Eenvoudige, basis → complex: Een andere manier om een discussie te structureren is te beginnen met de eenvoudige, basis, fundamentele eenheden en vervolgens over te gaan naar de meer complexe en technische.
- Object-in-rust → object-in-beweging: Een ander organisatiepatroon houdt in dat je eerst het ding beschrijft (alsof in een foto), en vervolgens de werking of het proces bespreekt (alsof in een video). Deze aanpak kan goed werken voor een discussie over een brandstofinjectiesysteem.
- Ruimtelijke beweging: — Als je de fysieke details van iets beschrijft, wil je misschien een patroon van fysieke beweging gebruiken, bijvoorbeeld van boven naar beneden, van links naar rechts, of van buiten naar binnen.
- Tijdelijke beweging: — Een van de meest voorkomende patronen is gebaseerd op beweging door de tijd; regel de bespreking van gebeurtenissen in relatie tot de temporele volgorde.
- Concept → toepassing van het concept, voorbeeldenEen veelvoorkomend organisatorisch patroon is om een concept in algemene termen te bespreken en vervolgens een toepassing ervan aan te kaarten. Bijvoorbeeld, een ander hoofdstuk in dit boek bespreekt voorstellen eerst conceptueel en behandelt vervolgens voorbeelden van voorstellen.
- Gegevens → conclusies: Een andere manier om informatie te organiseren is om gegevens (waarnemingen, experimentele gegevens, enquêteresultaten) te presenteren en vervolgens over te gaan tot de conclusies die uit die gegevens kunnen worden getrokken. (En dit patroon is soms omgekeerd: presenteer eerst de conclusie, dan de gegevens die deze ondersteunen.)
- Probleem, vraag → oplossing, antwoord: Je kunt informatie ook organiseren door eerst een probleem te bespreken of een vraag te stellen en vervolgens over te gaan op de oplossing of het antwoord.
- Vereenvoudigde versie → gedetailleerde versie: Een nuttige manier om technische zaken aan niet-specialisten uit te leggen, is om te beginnen met het bespreken van een vereenvoudigde versie van de zaak, een goed begrip daarvan op te bouwen, en daarna alles opnieuw uit te leggen, maar nu met veel technische details!
- Meest belangrijk → het minst belangrijk: Een meer "retorische" methode van organisatie is om te beginnen met de belangrijkste, de meest opvallende, de meest dramatische informatie eerst en vervolgens over te gaan naar informatie die progressief minder belangrijk is. (En dit patroon kan omgekeerd worden: je kunt opbouwen naar een climax, in plaats van ermee te beginnen.)
- Meest overtuigende → minst overtuigende: — Evenzo kun je beginnen met het meest overtuigende argument voor jouw standpunt — om ieders aandacht te krijgen — en dan verder gaan met minder en minder overtuigende argumenten. (Dit patroon kan ook omgekeerd worden: je kunt opbouwen naar je meest overtuigende argumenten.)
- Algemene → specifiek: Een gangbare manier om te organiseren is om stukken inhoud van algemeen naar specifiek te rangschikken. Bijvoorbeeld, het definiëren alle Zonnecollectoren is een algemenere discussie dan het bespreken van de verschillende types zonnecollectoren. En het beschrijven van de werking van een specifiek type zonnecollector is zelfs nog minder algemeen. Dit patroon wordt hier geïllustreerd:
Dit zijn slechts een paar mogelijkheden. Wanneer het doel informatief is, organiseer je informatie zodat je ervoor zorgt dat lezers de basis begrijpen voordat ze verder gaan met de gecompliceerde, technische zaken. Wanneer het doel overtuigend is, organiseer je dingen om het overtuigende effect op de lezers te maximaliseren, bijvoorbeeld door de sterkste argumenten eerst te plaatsen.
En vermijd in elk geval het mengen van deze benaderingen—bijvoorbeeld, sommige gegevens weggooien, dan enkele conclusies trekken, en dit vervolgens op een willekeurige manier heen en weer doen. Houd de appels gescheiden van de sinaasappels!
Versterk onderwerpzinnen en overzichten
Een van de beste dingen die je kunt doen, is teruggaan door een ruwe versie en controleren of je onderwerpzinnen en overzichten op belangrijke punten kunt invoegen. Wanneer we schrijven, zijn we normaal gesproken niet zeker waar een alinea of sectie naartoe gaat in termen van inhoud en logica. Zodra het er " is aangekomen," is het vaak nodig om terug te gaan naar het begin en een soort overzicht toe te voegen of wat er al staat aan te passen om het overzicht duidelijker te maken. Lezers moeten weten waar ze naartoe gaan in een rapport, wat er volgende komt, en voor dat matter waar ze net zijn geweest.
Een overzicht in een rapport is als een kaart wanneer je in een nieuwe stad bent. Onderwerpszinnen en overzichten bieden een perspectief op wat waar is: het onderwerp, de subonderwerpen, het doel van de komende discussie, de relatie tot de voorgaande sectie en tot het document als geheel. (Nu omvat een deel hiervan overgangen, wat het volgende element is om te bekijken.)
Voor een gedetailleerde behandeling van dit onderwerp, zie onderwerpzinnen en overzichten.
Versterk de samenhang, overgangen
Je kunt de juiste informatie in een rapport hebben en het goed georganiseerd hebben, maar er kan nog steeds iets belangrijks misgaan. Lezers kunnen de "stroom" van de ideeën missen, moeite hebben om te voelen hoe de stukjes informatie met elkaar verband houden of verbonden zijn. Wat lezers nodig hebben, is voortdurende begeleiding—wat jij als schrijver biedt. En wat je gebruikt om die begeleiding te bieden, wordt overgangen—genoemd, verschillende middelen die lezers helpen door een document te navigeren. Er is (of zou zeker moeten zijn) een logica die elke zin in een document met elkaar verbindt en die een bepaalde volgorde aan die zinnen dicteert.
Zie het hoofdstuk over coherentie en overgangen voor een gedetailleerde discussie en voorbeelden.
Controleer alinea lengte
Een laatste manier om je ruwe versie op het structurele niveau te reviewen, is om te controleren hoe je de alinea-onderbrekingen hebt gedefinieerd. Alinea's zijn vreemde wezens—sommige schrijvers geloven dat ze niet bestaan en gewoon willekeurige onderbreekpunten zijn die schrijvers erin gooien wanneer en waar ze maar willen. Sorry—in technische schrijven is de alinea een sleutelspeler in de strijd voor duidelijkheid en begrip. Hoewel het niet altijd mogelijk is, zouden alinea's moeten plaatsvinden wanneer er een verschuiving in onderwerp of subonderwerp is, of een verschuiving in de manier waarop een onderwerp wordt besproken.
Op een enkelgespatieerde volle pagina met tekst, zoek naar minstens één tot vier alinea-onderbrekingen—er is niets magisch aan dat gemiddelde, dus behandel het niet alsof het wet is. Kijk gewoon nog eens goed naar die lange alinea's en controleer op de mogelijkheid van alinea-onderbrekingen.
Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk op prijs stellen: je reactie—David McMurrey.
