Technical Writing

Dit hoofdstuk gaat over het voorstel – het soort document dat u of uw organisatie goedgekeurd of ingehuurd krijgt om een project te doen.

In een cursus technisch schrijven is de voorstelopdracht een kans voor u om een idee te presenteren aan een specifiek, met name genoemd publiek over een idee dat u hebt om een bepaald aspect van dat bedrijf, die organisatie, dat centrum of een ander bedrijf te verbeteren. Welk onderwerp je ook kiest, je moet in staat zijn om grondig wetenschappelijk onderzoek uit te voeren dat je in je eindverslag zult integreren.

Om te beginnen met het plannen van een voorstel, onthoud de basisdefinitie: een voorstel is een aanbod of offerte om een project voor iemand te voltooien. Voorstellen kunnen andere elementen bevatten – technische achtergrond, aanbevelingen, resultaten van enquêtes, informatie over de haalbaarheid, enzovoort. Maar wat een voorstel tot een voorstel maakt, is dat het publiek wordt gevraagd het voorgestelde project goed te keuren, te financieren, of toestemming te verlenen om het uit te voeren.

Een voorstel moet informatie bevatten die het publiek van dat voorstel in staat stelt te beslissen of het project moet worden goedgekeurd, of u moet worden goedgekeurd of ingehuurd om het werk te doen, of beide. Om een succesvol voorstel te schrijven, moet je jezelf in de plaats van je publiek – de ontvanger van het voorstel – stellen en bedenken welke informatie die persoon nodig zou hebben om er vertrouwen in te hebben dat jij het project uitvoert.

Het is gemakkelijk om verward te raken over voorstellen, of in ieder geval over het type voorstel dat je voor deze les gaat schrijven. Stel je voor dat je een geweldig idee hebt om een of andere nieuwe technologie te installeren waar je werkt, en je schrijft een document waarin je uitlegt hoe het werkt, de voordelen laat zien, en vervolgens het management aanspoort om het te installeren. Is dat een voorstel? Op zichzelf zou dit geen volledig voorstel zijn. Het zou meer lijken op een haalbaarheidsverslag, waarin de verdiensten van een project worden onderzocht en vervolgens aanbevelingen worden gedaan voor of tegen het project. Het enige wat echter nodig is om van dit document een voorstel te maken, is het toevoegen van elementen die het management om goedkeuring vragen om met het project door te gaan. Bovendien, voor deze klas, is een van die elementen wetenschappelijk onderzoek. Zeker, sommige schrijvers van voorstellen moeten de projecten die zij voorstellen verkopen, maar in alle gevallen moeten voorstellen de schrijver (of de organisatie van de schrijver) verkopen als degene die het project moet uitvoeren.

Typen voorstellen

Kijk eens naar de situaties waarin voorstellen voorkomen. Een bedrijf kan een openbare aankondiging doen uitgaan waarin om voorstellen voor een specifiek project wordt gevraagd. Deze openbare aankondiging, een zogeheten request for proposals (RFP), kan worden gedaan via websites, e-mails, sociale media, kranten of vakbladen. Bedrijven of personen die belangstelling hebben voor het project, schrijven dan voorstellen waarin zij hun kwalificaties, projectschema’s en kosten samenvatten en hun aanpak van het project bespreken. De ontvanger van al deze voorstellen beoordeelt ze, kiest de beste kandidaat en stelt vervolgens een contract op.

Maar voorstellen komen ook veel minder formeel tot stand. Stel u voor dat u belangstelling hebt voor een project op het werk (bijvoorbeeld een onderzoek naar de voordelen van de invoering van een nieuwe technologie om de produktiviteit te verhogen). Stel je voor dat je een ontmoeting hebt gehad met je supervisor en haar hiervan hebt proberen te overtuigen. Zij zou kunnen antwoorden met: “Schrijf me een voorstel en ik zal het aan het hoger management voorleggen.” Dit lijkt meer op het soort voorstel dat u in een cursus technisch schrijven zult schrijven.

De meeste voorstellen kunnen in verschillende categorieën worden onderverdeeld:

• Intern, extern: Een voorstel aan iemand binnen uw organisatie (een bedrijf, een overheidsinstantie, enz.) is een intern voorstel. Bij interne voorstellen hoeft u bepaalde onderdelen (zoals kwalificaties) of minder informatie op te nemen. Een extern voorstel is een voorstel van een afzonderlijke, onafhankelijke organisatie of persoon aan een andere, soortgelijke entiteit. Het typische voorbeeld is de onafhankelijke consultant die voorstelt een project voor een ander bedrijf uit te voeren. De kans is groot dat je een van deze twee soorten voorstellen voor deze klas schrijft, en het kan gevraagd of ongevraagd zijn, zoals hieronder wordt uitgelegd.
• Vraaggestuurd, ongevraagd: Een gevraagd voorstel is een voorstel waarbij de ontvanger om het voorstel heeft gevraagd. Gewoonlijk stuurt een bedrijf een verzoek om een voorstel (RFP) per post of publiceert het dit in een nieuwsbron. Maar voorstellen kunnen ook op een heel lokaal niveau worden gevraagd: je kunt bijvoorbeeld aan je baas uitleggen hoe geweldig het zou zijn om een nieuwe technologie op kantoor te installeren; je baas kan geïnteresseerd raken en je vragen om een voorstel te schrijven waarin wordt aangeboden om het idee formeel te bestuderen. Ongevraagde voorstellen zijn voorstellen waarbij de ontvanger niet om een voorstel heeft gevraagd. Bij ongevraagde voorstellen moet je de ontvanger er soms van overtuigen dat er een probleem of behoefte bestaat voordat je aan het belangrijkste deel van het voorstel kunt beginnen. De meeste projecten voor technisch schrijven die we in deze les hebben gezien, waren ongevraagde voorstellen.

Typische scenario’s voor het voorstel

Velen van u hebben er misschien nog nooit over nagedacht om een technisch rapport op te stellen op basis van een levensvatbaar voorstel. Op het opdrachtenblad staan verschillende voorbeeldonderwerpen; hier volgen nog enkele ideeën:

• Stel je voor dat een bedrijf een probleem heeft of een verbetering wil doorvoeren. Het bedrijf stuurt een verzoek om voorstellen; u ontvangt er een en reageert met een voorstel. U biedt aan te komen, te onderzoeken, te interviewen, aanbevelingen te doen en dit alles in de vorm van een rapport te presenteren.
• Een organisatie wil een seminar over uw deskundigheid. U schrijft een voorstel om het seminar te geven – in het pakket is een gids of handboek opgenomen dat de deelnemers aan het seminar zullen ontvangen.
• Een bureau heeft zojuist een nieuw online datasysteem in gebruik genomen, maar de gebruikershandleiding is technisch ingewikkeld en moeilijk te lezen. U ontvangt een verzoek om voorstellen van dit bureau om een vereenvoudigde gids of opstartgids te schrijven.
• Stel dat een non-profitorganisatie die zich op een bepaald onderwerp richt, een consultant wil om een handboek of gids voor haar leden te schrijven. Dit document zal informatie over de kwestie presenteren op een manier die de leden kunnen begrijpen.

Niet alle onderzoeksonderwerpen zijn geschikt voor technisch schrijven. Onderwerpen die gebaseerd zijn op waarden en overtuigingen vallen niet in de categorie technisch. Historische en literaire onderwerpen komen niet in aanmerking. Overleg altijd met je docent over het onderwerp voordat je aan je project begint.

Denk er bovendien aan dat je wetenschappelijk onderzoek moet integreren in je eindverslag, kies een onderwerp waarvoor je dergelijk materiaal gemakkelijk kunt vinden. Hoewel interviews en andere bronnen uit de eerste hand vaak waardevol zijn voor een verslag, zal een verslag dat zwaar leunt op deze bronnen niet voldoen aan de resultaten van deze cursus.

Gemeenschappelijke secties in voorstellen

Hierna volgt een overzicht van de secties die je vaak zult aantreffen in voorstellen, die in deze klas in memo-formaat worden ingediend. Ga er niet van uit dat elk van deze onderdelen moet voorkomen in het voorstel dat je schrijft, of dat ze moeten voorkomen in de volgorde waarin ze hier worden gepresenteerd. Raadpleeg het opdrachtblad en overweeg andere soorten informatie die uniek zijn voor uw onderwerp en die in uw specifieke voorstel moeten worden opgenomen.

Terwijl u dit hoofdstuk over voorstellen leest, bekijkt u de voorbeeldmemo van het voorstel die u in de unitmap van deze week vindt. Nogmaals, houd er rekening mee dat niet alle hier besproken onderdelen in de voorbeelden terugkomen, maar de meeste wel.

Inleiding. Plan de inleiding van uw voorstel zorgvuldig. Zorg ervoor dat het alle volgende dingen doet (maar niet noodzakelijkerwijs in deze volgorde) die van toepassing zijn op uw specifieke voorstel:

• Aangeven dat de inhoud van de memo een voorstel voor een specifiek project is.
• Ontwikkel ten minste één korte motiverende verklaring die de ontvanger zal aanmoedigen om verder te lezen en te overwegen het project goed te keuren (vooral als het een ongevraagd of concurrerend voorstel is).
• Geef een overzicht van de inhoud van het voorstel.

Achtergrond bij het probleem, de kans of de situatie. In het deel over de achtergrond, dat vaak direct na de inleiding volgt, wordt besproken waarom het project nodig is – welk probleem, welke kans op verbetering, wat de uitgangssituatie is. Het management van een keten van kinderdagverblijven moet er bijvoorbeeld voor zorgen dat alle werknemers reanimatie kennen omdat de staat dat voorschrijft, of een eigenaar van dennenbossen in Oost-Oregon wil misschien dat de grond verkoopbaar hout oplevert zonder het milieu te vernietigen.

Hoewel de doelgroep van het voorstel het probleem misschien heel goed kent, is het schrijven van de achtergrondparagraaf nuttig om uw specifieke visie op het probleem te laten zien. Ook als het voorstel ongevraagd is, is een achtergrondparagraaf bijna een vereiste – u zult het publiek er waarschijnlijk van moeten overtuigen dat het probleem of de kans bestaat en dat het moet worden aangepakt.

Voordelen en haalbaarheid van het voorgestelde project. In de meeste voorstellen wordt kort ingegaan op de voordelen van de uitvoering van het voorgestelde project. Dit fungeert als een soort argument ten gunste van de goedkeuring van het project. In sommige voorstellen wordt ook de waarschijnlijkheid van het welslagen van het project besproken. In een ongevraagd voorstel is dit gedeelte extra belangrijk: je probeert het publiek te “overtuigen” van het project.

Beschrijving van het voorgestelde werk (resultaten van het project). In de meeste voorstellen moet het eindproduct van het voorgestelde project worden beschreven. In een cursus technisch schrijven betekent dat een beschrijving van het geschreven document dat je voorstelt te schrijven, het publiek en het doel ervan; het geven van een schets; en het bespreken van zaken als de lengte, afbeeldingen, binding, enzovoort. In het scenario dat u schetst, kan er sprake zijn van andere werkzaamheden, zoals het geven van opleidingsseminars of het verlenen van een doorlopende dienst. In dit vroege stadium weet je misschien niet alles wat er nodig is om je project te voltooien, maar je zou op zijn minst een idee moeten hebben van een aantal van de vereiste stappen.

Methode, procedure, theorie. In sommige voorstellen moet je uitleggen hoe je het voorgestelde werk gaat voltooien. Dit is een extra overtuigend element; het laat het publiek zien dat u het project op een degelijke, doordachte manier aanpakt. Ook laat het zien dat je de kennis van het vakgebied hebt om het project te voltooien.

Programmering. De meeste voorstellen bevatten een onderdeel waarin niet alleen de verwachte voltooiingsdatum wordt vermeld, maar ook de belangrijkste mijlpalen voor het project. Als u een groot project uitvoert dat zich over vele maanden uitstrekt, vermeldt de tijdlijn ook de data waarop u voortgangsrapporten indient. Als u geen specifieke data kunt noemen, noem dan de tijd die voor elke fase van het project nodig is.

Kosten, benodigde middelen. De meeste voorstellen bevatten ook een onderdeel waarin de kosten van het project worden vermeld, ongeacht of het om interne of externe projecten gaat. Bij externe projecten moet u wellicht uw uurtarieven, de geraamde uren, de kosten van apparatuur en benodigdheden, enz. vermelden en vervolgens de totale kosten van het volledige project berekenen. Interne projecten zijn natuurlijk niet gratis, dus moet je nog steeds de projectkosten vermelden: uren die je nodig zult hebben om het project te voltooien, apparatuur en benodigdheden die je zult gebruiken, hulp van andere mensen in de organisatie, enzovoort.

Conclusies. De laatste alinea of het laatste deel van het voorstel moet de lezers weer op de positieve aspecten van het project wijzen. In het laatste deel kun je hen aansporen contact met je op te nemen om de details van het project uit te werken, hen herinneren aan de voordelen van het doen van het project, en misschien nog een laatste argument voor jou of je organisatie als de juiste keuze voor het project naar voren brengen.

Speciale projectspecifieke delen. Vergeet niet dat de voorgaande onderdelen typisch of gebruikelijk zijn in geschreven voorstellen, en geen absolute vereisten. Vraag uzelf altijd af wat uw publiek nog meer nodig heeft om het project, de noodzaak ervan, de voordelen die eruit voortvloeien, uw rol erin en uw kwalificaties om het uit te voeren, te begrijpen. Wat moeten ze nog meer zien om het project goed te keuren en jou goed te keuren om het uit te voeren?

Speciale opdrachtvereisten

Afhankelijk van de schrijfsituatie kan het zijn dat je voorstel ook andere gespecialiseerde elementen moet bevatten. Sommige daarvan worden hieronder beschreven. Opmerking: sommige van deze elementen zullen in uw voortgangsmemo voor deze cursus worden vereist; in een echte technisch schrijven-situatie kan uw supervisor u echter vragen om een van de volgende elementen in uw voorstel op te nemen:

Doelgroep: Beschrijf het publiek van het eindrapport (dat anders kan zijn dan het publiek van het voorstel). Misschien moet u bespreken voor wie het rapport is bedoeld, hun titels en functies, hun technische achtergrond, en hun vermogen om het rapport te begrijpen.

Informatiebronnen: Maak een lijst van informatiebronnen; zorg ervoor dat je weet dat er voldoende informatie is voor je onderwerp; maak een lijst met citaten voor specifieke boeken, artikelen, naslagwerken, andere soorten bronnen waarvan je denkt dat ze zullen bijdragen aan je verslag.

Grafieken: Maak een lijst van de grafische voorstellingen die je voor je verslag nodig denkt te hebben, gerangschikt naar soort en inhoud. (Als je er geen kunt bedenken die je verslag nodig zou hebben, heb je misschien geen goed onderwerp – brainstorm er dan over met je docent). Voor dit vak moet je afbeeldingen maken en in je eindverslag opnemen.

Outline: Voeg een schets toe van de onderwerpen en deelonderwerpen die je in je verslag denkt te behandelen.

Voorstellen en publiek

Bedenk dat, in een cursus technisch schrijven, de voorstelopdracht verschillende doelen dient: (1) het geeft je enige ervaring in het schrijven van een voorstel; (2) het laat je beginnen met het plannen van je termijnrapport; (3) het geeft je docent een kans om met jou aan je project te werken, om er zeker van te zijn dat je een levensvatbaar onderwerp hebt. Om de tweede en derde reden moet je specifieke elementen in je voorstel opnemen (zoals vermeld in je opdrachtblad) waarvan sommige misschien niet geschikt lijken in een voorstel uit de echte wereld.

In deze cursus technisch schrijven is het voorstel het begin van een wekenlang onderzoeks- en schrijfproces dat vele stadia doorloopt tot het eindpunt: het technisch verslag. Je dient het voorstel slechts één keer in tijdens dit proces. Daarna zul je verschillende soorten documenten schrijven en indienen: een voortgangsverslag, een schets, een geannoteerde bibliografie, een grafisch ontwerp, een ontwerpverslag, en een eindverslag. Let erop dat je de term “voorstel” alleen gebruikt als je specifiek verwijst naar de beginfase van je project.

Een ander punt om in gedachten te houden heeft te maken met het publiek voor voorstellen versus het publiek voor verslagen die later in het schrijfproces komen. Het publiek voor je voorstel is de persoon die je onderzoek en schrijven kan goedkeuren, steunen en eventueel financieren. Het eindrapport dat je opstelt, kan voor een ander publiek bedoeld zijn. Neem het voorbeeld van een voorstel aan een supervisor van een zonne-energiebedrijf, waarin wordt voorgesteld een handleiding op te stellen voor installateurs van residentiële zonnepanelen. De doelgroep van het voorstel kan een leidinggevende zijn, wiens kennis van de technische aspecten zeer breed kan zijn. Het eindrapport daarentegen is bestemd voor de technici, die wellicht meer gespecialiseerde kennis hebben dan de leidinggevende. De inhoud en het taalgebruik voor deze twee verschillende doelgroepen zullen moeten worden aangepast aan de schrijfsituatie. (Lees voor meer informatie hierover het hoofdstuk over publieksanalyse.)

Revisiechecklist voor voorstellen

Houd bij het herzien van je voorstel het volgende in gedachten:

• Gebruik de juiste indeling. Vergeet niet dat u dit voorstel voor deze cursus in memo-formaat schrijft.
• Schrijf een duidelijke samenvatting van (of inleiding op) het onderwerp van uw voorstel.
• Benoem precies wat u voorstelt om te doen.
• Zorg ervoor dat een rapport – een schriftelijk document – op de een of andere manier betrokken is bij het project dat u voorstelt om te doen. Vergeet niet dat we in deze cursus technisch schrijven zowel oefenen met het schrijven van een voorstel zoals dat in de echte wereld wordt gedaan, als met het voltooien van een onderzoeksproject op universitair niveau.
• Zorg ervoor dat de onderdelen van je voorstel in een logische, natuurlijke volgorde staan en dat je subkoppen en opsommingstekens (en eventuele andere opmaakstijlen) op de juiste manier gebruikt.
• Hiermee richt je je voorstel tot het beoogde publiek – niet tot je docent.

Hoofdstuk Attributie-informatie