Over het algemeen is de taak van een technisch schrijver er één: een dergelijke tekst opstellen waarmee een nieuwe gebruiker het programma of apparaat correct kan gebruiken.
Een technisch schrijver kan tijdens de ontwikkelingsfase van een toekomstig product aansluiten bij een werkgroep. Het product moet worden getest, kenmerken en alle mogelijke functies moeten worden bestudeerd. Het resultaat van het werk is een volledige instructie met een gedetailleerde beschrijving van het gebruik van het product, vergezeld van duidelijke illustraties.
De belangrijkste tools van een technisch schrijver zijn een teksteditor, een voicerecorder en, afhankelijk van de specifieke kenmerken van het project, MS Manual of Style, Apple Style Manual, Chicago Manual of Style, MS Word, Adobe FrameMaker (voor het maken van offline materiaal), Adobe RoboHelp, MadCapFlare (voor online documentatie) en anderen.
Ken uw werkterrein
Iedereen is zich terdege bewust van de zin: "Als al het andere faalt, lees dan eindelijk de instructies." Maar hoe kun je instructies schrijven zodat de wens om deze te lezen al ontstaat voordat je met het softwareproduct aan de slag gaat? Hoe maak je het informatief voor zowel ervaren gebruikers als nieuwkomers? Als technisch schrijver moet je het volgende en een beetje meer beheersen:
- het bepalen van de samenstelling en structuur van documenten die zijn opgenomen in de documentatieset;
- de vereisten voor documentatie bepalen en zich daardoor laten leiden in het werk;
- de inhoud van documenten effectief presenteren;
- documentatie opstellen in de gewenste stijl;
- de relevantie van de documentatie waarborgen, de wijzigingen volgen.
Sommige IT-bedrijven hebben een technisch schrijver nodig om opmaaktalen of een van de programmeertalen op het niveau van codelezen te kennen, terwijl andere vaardigheden nodig hebben in het werken met databases of querybeheersystemen.
Toon interesse en blijf betrokken
Wat zeker van pas zal komen, is interesse in het gebied waarover je schrijft: als een technisch schrijver niet geïnteresseerd is in het vakgebied waarin hij werkt, zal het moeilijk voor hem zijn. Zo'n beroep is niet geschikt voor mensen die niet klaar zijn om hun taalniveau te verbeteren, zowel in het buitenland als in het buitenland. Als een persoon hierin geïnteresseerd is, zal hij zichzelf in dit beroep vinden.
Meester DITA
Het DITA-formaat bleek over het algemeen een zeer handig hulpmiddel te zijn voor het ontwikkelen van technische documentatie met zijn specifieke inhoud. We kunnen bijvoorbeeld elk tekstblok of een hele sectie van het ene document in een ander document hergebruiken. En dit zal niet het gebruikelijke "kopiëren en plakken" zijn, maar het gebruik van één blok in verschillende documenten. Als er iets verandert in dit blok, is het voor ons voldoende om de tekst één keer te wijzigen - de wijziging gaat automatisch naar alle documenten. We kunnen ook filters toepassen - schrijf één universele sectie, voeg deze in verschillende documenten in en filter vervolgens de inhoud ervan, afhankelijk van het type document, klant, systeem en andere parameters. En we denken ook niet aan kruisverwijzingen tussen secties - het is voldoende om op de juiste plaats de sleutel aan te geven van de sectie waarnaar we willen verwijzen. Bij het samenstellen van een document zal de Toolkit de secties zelf nummeren en mooie hyperlinks maken.
Proeflezen: het werkt nog steeds
… ook voor professioneel technisch schrijven!
Wanneer een schrijver klaar is met werken aan een document, moet hij / zij het ter beoordeling indienen. Bedrijfsanalisten, ontwikkelaars, testers controleren de documentatie. Dit is een zeer belangrijke fase omdat een schrijver altijd een fout kan maken - om iets verkeerd te begrijpen, om geen rekening te houden met enkele niet-gedocumenteerde implementatiefuncties.
Aarzel niet om hulp te vragen
Als je nog maar een beginner bent, of technisch schrijven een onderdeel is van je studieprogramma, of je hebt niet genoeg tijd om je technische huiswerk af te maken voor de deadline, overweeg dan om het te delegeren aan een professionele hulpdienst voor opdrachten, zoals Mijn opdrachtenlab. Allereerst ben je zeker niet de eerste student die deskundige hulp nodig heeft bij het maken van technische huiswerkopdrachten, en de diensten staan volledig klaar om je te helpen, zelfs als het project complex is en de deadline schrikbarend dichtbij is. Het is tijd om toe te geven dat het beter is om te delegeren dan te falen. Het plaatsen van een technische schriftelijke bestelling duurt niet lang - u vermeldt gewoon de details van de bestelling, voegt de aanvullende materialen toe, vermeldt de vereisten en de deadline, kiest een betalingsmethode. Hoe eerder u bestelt, hoe minder u betaalt. Spoedbestellingen zijn het duurst. Het bestellen van technische schrijfstukken van ervaren auteurs helpt je echter om zelf een betere schrijver te worden. Bestudeer de ontvangen materialen en gebruik ze als voorbeeld voor verdere taken.
Neem deel aan online TW-Quests
Er is veel dat je kunt leren door te concurreren. IT-specialisten houden hackathons en andere wedstrijden. Technische schrijfopdrachten zijn momenteel niet zo populair, maar je kunt er in elk seizoen een of twee vinden. Het is leuk om aan dergelijke evenementen deel te nemen en het helpt ook bij het ontwikkelen van je unieke stijl, het leren van de besten en de slimsten en het aanscherpen van je vaardigheden. Het belangrijkste idee is om betrokken en creatief te blijven, om deel uit te maken van de technische schrijfgemeenschap.
Technisch schrijven is een waardevol onderdeel van het vertalen van de ene taal naar dezelfde taal - van technische taal naar gebruikstaal. Het is een bevredigende en interessante baan die constant leren, focus, het bestuderen van nieuwe programma's en deel uitmaken van de gemeenschap vereist.
