Technisch schrijven voor de verschrikte
IntroductionSometimes kan worden dan een begroting van bedrijven of personen te huren een professioneel schrijver om hun technische documentatie aan te pakken. Hoewel in een ideale wereld alle technische documentatie moeten worden geproduceerd door een goed opgeleide deskundige, helaas we niet leven in een ideaal. Op dezelfde manier dat veel mensen zullen proberen om hun eigen huishoudelijke apparaten repareren, zullen veel mensen proberen om de kwaliteit te schrijven van technische documenten. Net als gehannes met een broodrooster kan leiden tot elektrocutie, poging om technische documenten van de grond af te schrijven zonder voorafgaand advies zal uiteindelijk resulteren in falen. Als een ruwe vuistregel je altijd moet proberen een specialist in dienst te nemen, maar als om welke reden kunt u niet en u bent de armen jammer dat heeft gehad documentatie rechten opgedrongen op hen, wanhoop niet. Deze beknopte gids schetst een aantal van de belangrijkste vaardigheden die u moet u om uw schrijven, technische verdragen zich bewust zijn van, de software pakketten die u kunt overwegen, en bepaalde dingen te vermijden. Hopelijk zelfs als je nog nooit hebt geschreven een zin in je leven over alles vaag technische zul je op zijn minst, is een breder beeld van wat technisch schrijven entails.What Technisch schrijven? Technisch schrijven verrassend genoeg, verwijst naar het schrijven van dat technische is. Hoewel Dit lijkt misschien een bedrieglijke definitie, het is een belangrijk om te onthouden. Te veel technische auteurs maken de fout van het creëren van documenten die ofwel te technisch of te 'literair'. Een goede technische auteur moet in staat zijn om het evenwicht tussen de twee de eindgebruiker van de documentatie aan te passen aan te passen. Technisch schrijven is veel als frisse lucht, alomtegenwoordig en toch vrijwel onzichtbaar. In de vreemde wereld in bedraad waarin wij ons bevinden, technisch schrijven is overal. Software handleidingen, handleidingen voor huishoudelijke apparaten, educatieve folders, e-mails, brieven, rapporten, technisch nieuws, statistieken en biografieën over televisie toont alle sporten zijn voorbeelden van technisch schrijven waaraan mensen worden blootgesteld aan op een dagelijkse basis. Als u ooit hebt geprobeerd om de tijd instellingen op een home video recorder programma en de handleiding in geslingerd de kamer in walging, gooide je een stuk van technisch schrijven (hoewel natuurlijk niet een heel goed!). Te vaak technische literatuur wordt geproduceerd door schrijvers met een niet groot genoeg greep van de technologie, of technologen dat het gebrek aan het vermogen om te schrijven. Als een prospectieve technische auteur moet u het loopvlak de zeer delicate lijn van zijn technisch deskundige in uw vakgebied (en) en als een 'goed' schrijver (als tegenstelling tot 'slecht' schrijvers die kunnen meestal worden gevonden overval lieve oude dames of zoiets). Technische documentatie is meestal geproduceerd voor twee verschillende groepen gebruikers, namelijk het niveau van deskundigen gebruikers, en naïeve gebruikers. Als technische auteur een van de eerste taken is het soort publiek wat je schrijft voor, dat brengt mij behendig naar: Ken uw foeAs de oude clichÃÆ'Ã,  © gaat, iedereen is een criticus. Dit geldt met name van de reactie van de meeste gezonde mensen wanneer zij worden geconfronteerd met technische schrijven. Zoals werd benadrukt in het voorbeeld van de videorecorder bovenstaande kan technisch schrijven ondoordringbaar worden aan de eindgebruiker. Als dit het geval is, is dat omdat wie schreef de documentatie, niet de moeite om hun publiek te identificeren en te schrijven naar hun niveau. Het lijkt een duidelijk punt te maken, maar een die vaak over het hoofd gezien, dat de gebruiker van de documenten die je maakt, kan niet echt een expert. Natuurlijk, als je het maken van een document over een bepaald product specialist voor een bepaalde gevorderde groep gebruikers (een goed voorbeeld zou kunnen zijn auditing software voor computer systeem beheerders), dan moet u dit componeren is een geheel andere manier dan wanneer u maakt bijvoorbeeld een technische handleiding voor de massamarkt software gericht op de onervaren gebruiker thuis. Een de eerste taken die je moet volbrengen alvorens je zelfs stellen pen en papier, van de vinger aan toetsenbord, is vast te stellen wie de gebruiker van uw documenten worden en construeren documenten die gericht zijn op die specifieke doelgroep (en). Als krijg je dit stadium te corrigeren, moeten zij voorkomen dat uw documenten dat in de kamers in ergernis! Planning voor perfectionOnce u heeft gewezen op de doelmarkt voor de documenten die u zullen worden geworpen maken, moet u om te beginnen te plannen hoe de documenten zullen worden georganiseerd. Dit proces is grotendeels afhankelijk van welke documentatie wordt geproduceerd, maar u kunt volgen een paar ruwe vuistregels. Ten eerste, als de documenten zijn ondersteuning van een bijzonder gedetailleerde product (zoals een computer applicatie) krijg je vieze handen op het zo snel als je kunt. Bij de behandeling van het product in detail kunt u een plan van aanpak te formuleren en te beginnen aan een componeren organisatiestructuur. Terwijl u het verkennen van het product in detail te nemen overvloedige notities, als dit te doen tijdens de eerste verkennende fase kunt u tijd besparen dat kan van cruciaal belang zijn als u werken aan termijn. Zelfs in de planningsfase moet u zorgen dat er een samenhang te lay-out, en organisatorische structuur voor het document. Selecteer nummering verdragen, paragraaf stijlen, en het genereren van ruwe ideeën voor lay-out doeleinden nu, en bespaar vitale tijd later.Let een ontwerp inBefore Headfirst duik in het creëren van de documentatie, een ontwerp uit elke sectie eerst. Dit zal toelaten om de volgorde als de documenten worden gecreëerd hebben geen logische 'flow', zonder ernstige gevolgen hebben op het project. Veel technische documenten (met name voor meer gedetailleerde producten) zijn samengesteld uit tal van (en in sommige gevallen bijna ontelbare) iteraties. Dit omdat het product verschuivingen en veranderingen in de tijd, en een van de belangrijkste taken van een technisch auteur is op de hoogte blijven van deze veranderingen, en ervoor te zorgen dat ze allemaal goed gedocumenteerd. Goede technische auteurs altijd duwen hun documenten via zoveel ontwerpen als menselijkerwijs mogelijk is, raffinage over elk ontwerp, totdat ze een positie waarbij zij (en hun werkgever) ervan overtuigd is dat de documentatie is tijdig, accuraat en bereik een getrouwe weergave van het product of proces het documents.The venijn in de detailAs reeds geïdentificeerd, is technisch schrijven heet dat, omdat het technisch van aard is. Een deel van zijn technisch van aard is om precies te zijn, en een deel van precisie is zo gedetailleerd als menselijkerwijs mogelijk is. Zelfs als de documenten die u maakt zijn voor een geavanceerde en technologisch geavanceerde groep gebruikers, moet uw documentatie concentreren op de details van een proces, of het gebruik van een product. Dit kan een huzarenstukje te volbrengen, maar niet als u schrijven naar uw doelgroep. Nooit uitgaan dat de lezer weet niets over het product of proces worden gedocumenteerd, maar in het geval van geavanceerde / deskundige gebruikers op zijn minst het gezond verstand aan het feit dat zij waarschijnlijk niet hoeven te worden verteld hoe de apparatuur die zij opereren op een dagelijkse basis te gebruiken. Bij de beschrijving van hoe het uitvoeren van een bepaalde activiteit of taak, het identificeren van elke fase worden (nummer ze als dit de conventies van het type document dat u maakt past) en te zorgen voor de juistheid van wat je hebt geschreven test het zelf, of zelfs beter, touw in een vrijwilliger van dezelfde vaardigheden niveau als aan het einde het juiste gereedschap voor de jobAlthough is het mogelijk om technische documenten met behulp van perkament en bloed te creëren user.Choose, is het niet raadzaam. Veel specialist software toepassingen bestaan om u te helpen creëren krachtige documentatie, en een deel van uw taken als technisch schrijver, onder meer selecteren van de juiste tool voor de job. Grotendeels dit is afhankelijk van de aard van de documenten geproduceerd, en de aard van de uiteindelijke distributie. Indien de documenten kunnen worden geleverd via het internet, dit is zeker een weg te denken. Daartoe gebruik maken van pakketten zoals Flash MX en Dreamweaver dit doel te bereiken. Voor geïntegreerde online hulp kan die je wilt maken ruwe HTML-documenten, of anders kies een specialist pakket zoals RoboHelp of iets dergelijks. In het geval van druk op basis van documenten, moet je het selecteren van een softwarepakket krachtig genoeg om te verwerken wat je wilt gooien it.Many onervaren technische auteurs direct de beurt aan Microsoft Word (zoals het alomtegenwoordig is mei commerciële en prive-omgevingen). Tenzij uw documentatie zal worden onder 150 pagina's, en u weet hoe u sjablonen en macro's te maken, te voorkomen MS Word. Zoals elke technische auteur zal u vertellen heeft nare gewoonten al is het eigen, en kunnen vaak een instabiele pakket om mee te werken. Als u graphics zijn waardoor zware documentatie, kunt u overwegen Quark Xpress, of kies potentieel de marktleider in het veld, Adobe Framemaker. Welke software die je selecteert, moet u ervoor zorgen dat u zich ongelooflijk bedreven met haar, hetzij door te investeren in opleiding, of met behulp van het dag na dag na dag! Communiceer - dat is wat je betaald om te doen! Veel mensen zal u vertellen dat het creëren van technische documentatie is saai en repetitief. Deze mensen zijn verkeerd, en eventueel idioten ook. Hoewel u vindt het proces van het creëren van technische documentatie 'saai' (als je U bent in de verkeerde baan!) is het niet. Scheppen van hoogwaardige technische documenten is een belangrijke fase in waardoor mensen adequaat en correct te gebruiken technologie. Hoewel er geen gebruiker zal de aanpak van de documentatie die u maakt in op dezelfde manier als zij een nieuwe benadering, kan je uiteindelijk helpen bereiken wat ze willen bereiken met behulp van technologie. Maakt niet uit hoe 'saai' het proces lijkt te zijn, zodat gebruikers hun doelen te bereiken door het lezen van uw documenten moeten geven u een stormloop van trots en inderdaad, geluk. Zolang je nog de positieve effecten die technologie kan hebben op het leven van mensen, wanneer u uw documenten die u kunt communiceren effectiever, zoals u gelukkiger in het communicatieve proces. Gedurende de levenscyclus van documenten dient u te proberen contact te onderhouden met collega's zo vaak mogelijk (indien van toepassing). Laat je ze te lezen documenten, luisteren naar hun kritiek, en pas uw documenten (als je niet kunt stellen uw hoek!). Een technisch auteur wordt betaald om te communiceren, zorg ervoor dat je nooit doen, en vergeten waarom je met elkaar communiceren, en om wie, in de documenten themselves.Common fouten te vermijden makingWhen het creëren van technische documenten zijn er een aantal fatale fouten je kunt maken. Hoewel niet volledig, dit gedeelte details aantal van de meer voorkomende fouten nieuwe auteurs te maken, in de hoop dat u zal vermijden dat ze ook: Being betuttelend - Hoewel de technische documentatie moet duidelijk zijn, moet het nooit betuttelend. U bent niet het creëren van documenten gelezen worden door idioten maar consumenten en klanten. Je moet altijd schrijven naar de vaardigheden van uw publiek, maar niet uit wat technisch niveau mensen op, ze zijn geen idioten. Zelfs kinderen krijgen beledigd wanneer betutteld, niet die fout maken met iemand die het betalen van uw salaris, kind of otherwise.Overuse voor humor - Mensen niet lezen technische documenten te vermaken, lees ze hen in de hoop met succes voltooiing van een proces, of de winning van informatie. Tenzij het relevant is voor de eindgebruiker te voorkomen humor waar mogelijk. Als u het schrijven van een boek, fijn en goed. Als u het schrijven van een handleiding, te vermijden humor zoals de pest, zoals vaker wel dan niet-gebruikers zullen missen de grap en net uiteindelijk walging de neerbuigende idioot dat de documentation.Inconsistency schreef - Zelfs bij het opstellen, moet u ervoor zorgen dat alle elementen gebruikt in uw document consistent zijn. Dit geldt evenzeer voor de 'toon' van het document als de lay-out ervan. Zorg ervoor dat u consequent gebruik zintuigen (eerste persoon, enz.) als pagina-indeling, paginering elementen, kop-en voetteksten, en alle andere tekstuele elements.Proof lezen - Tegen het einde van het creëren van een stuk van technische documentatie, zult u waarschijnlijk ziek worden van de aanblik van het. Dat doet er niet toe. Waar het om gaat is wat laat uw kantoor of thuis, juist is. Daartoe bewijs het document te lezen in al het ontwerpen, en voordat het wordt gedistribueerd bewijs lees het opnieuw, en opnieuw, en opnieuw. Vertrouw nooit op spell checkers (ze nooit werken) en als je kunt vermijden, nooit alleen vertrouwen op je eigen oordeel. Haal uw document te lezen door zoveel paar ogen mogelijk voorafgaand aan de distributie, na al konden ze het enige wat je hebt gemist plek gehele schepping process.Conclusion / Shameless self promotionTechnical schrijven is niet onafhankelijk van wat je mag denken, een makkelijke baan. Het vereist deskundigheid, geduld en een zeer vreemde mix van vaardigheden. Net als een andere baan, kun je leren hoe dat te doen, maar zelfs dat collegegeld niet noodzakelijkerwijs zal u goed in. Om een goede technische auteur, moet je anale nog creatief, gericht nog communicatief, en een flexibele deskundige. Dit is, zoals u waarschijnlijk kunt voorstellen, is geen eenvoudige taak. Hoewel u misschien denkt het maken van technische documenten is eenvoudig, het creëren van accurate, consistente en tijdige documentatie aan een hoge commerciële norm is een zeer uitdagende rol. Ongeacht uw budget, op de lange termijn zal een aanzienlijke ROI als u een specialist inhuren. Immers, zij kunnen doen in dagen, wat je scheur je haar onze poging tot volbrengen in weken zo niet de AuthorOver de jaren Mike Kemp is werkzaam als freelance IT-journalist months.About (werken voor publicaties zoals The Register, Namesfacesplaces, Security Focus en Packetstorm), een copywriter, videospelletjes ontwerper, veiligheid accountant, webdesigner, grafisch ontwerper en IT-trainer. Hij heeft gewerkt in een verscheidenheid van freelance en vaste functies voor zowel kleine (bv. twee mannen en een hond) bedrijven multinationale organisaties in zowel het Verenigd Koninkrijk en Europa. Als hij niet werkt op diverse artikelen, boeken, handleidingen en diverse andere exemplaar voor de klanten, kan Mike meestal worden gevonden zwoegen op een verscheidenheid van gepubliceerde romans. Hij heeft verscheidene van zijn korte scenario's geproduceerd door onafhankelijke productiemaatschappijen, en werkt momenteel op diverse functie lengte scripts.Mike leeft gelukkig meestal in een verschrikkelijk
Artikel Bron: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster krijgen html code
Voeg dit artikel aan uw website!
Webmaster verzenden van artikelen
Geen registratie vereist! Vul het formulier in en uw artikel is in de Messaggiamo.Com Directory!
