Technická písanie pre vydesených
IntroductionSometimes to môže byť za spoločností alebo jednotlivcov rozpočtu najať profesionálny spisovateľ riešiť ich technickej dokumentácii. Aj keď sa v ideálnom svete, všetky technickej dokumentácie by mali byť vyrábané od vysoko vzdelaných odborníkov, bohužiaľ nežijeme v ideálnom. Rovnakým spôsobom, že veľa ľudí sa pokúsi opraviť vlastné domáce spotrebiče, sa veľa ľudí snaží napísať kvalitné technické dokumenty. Rovnako ako si hrať s sendvičovač môže vyústiť v elektrickom kresle, pokúša sa písať technické dokumenty od nuly a bez predchádzajúceho odporúčania môže nakoniec viesť k zlyhaniu. Ako hrubé orientačné pravidlo vždy by ste mali hľadať zamestnávať špecialistov, ale ak z nejakého dôvodu nemôžete a ste chudobní nešťastné, že má povinnosti dokumentácie vnuceného im, nezúfajte. Tento stručný sprievodca opisuje niektoré z kľúčových zručností, budete potrebné, aby do svojho písania, technické dohovorov, ktoré majú byť vedomí, softvérové balíky, môžete zvážiť, a jednoznačné veci, aby sa zabránilo. Dúfajme, že aj keď ste nikdy nenapísal vetu vo svojom živote o ničom nejasne technickej budete mať prinajmenšom, širší obrázok o tom, čo sa technickej písanie entails.What Technické písania? Technické písania nijako prekvapivo dosť, sa odvoláva na písanie, ktoré je technickej. I keď to môže zdať ako klamný definície, je to dôležité, to pamätať. Príliš veľa technických autori robia tú chybu, tvorba dokumentácie, ktorá je buď príliš technické, alebo príliš 'literárne'. Dobrom technickom autor by mal byť schopný nastaviť rovnováhu medzi týmito dvoma, aby vyhovovalo konečnému užívateľovi dokumentácie. Technická písanie je veľa rád čerstvý vzduch, všadeprítomná a pritom do značnej miery neviditeľný. V káblovej divný svet, v ktoré sa nachádzame, technické písanie je všade. Software, manuály, užívateľské príručky pre domáce spotrebiče, náučná letáky, e-maily, listy, správy, technické novinky správy, štatistiky a životopisy na televízne športové ukazuje všetky sú príklady technické písanie, na ktoré sú ľudia vystavení na dennej báze. Ak ste niekedy skúšali programovať nastavenia času na záznam domáceho videa a hodil cez ručné izba s odporom, ste hodil kus technického písania (aj keď samozrejme nie moc dobrý!). Mnohokrát technická literatúra je vyrábaný s spisovatelia nie sú dosť veľké pochopenie technológie, alebo techniky, ktoré nemajú schopnosť písať. Ako perspektívne technické autor musíte šliapať veľmi jemné línie sú technicky svoje odborné vedomosti z odboru (y), rovnako ako 'dobrý' spisovateľ (ako na rozdiel od 'zlé' spisovatelia, ktorí zvyčajne sa nachádza prepadnutí sladký starej dámy, alebo tak niečo). Technická dokumentácia sa zvyčajne vyrába pre dve odlišné skupiny užívateľov, a to odbornej úrovni užívateľov a naivný užívateľa. Ako Technické autor jeden z Vašich prvých úloh je vyriešiť to, čo diváci písanie pre, čo ma privádza k obratne: Viem o tvojich foeAs staré clichÃÆ'Ã,  © platí, každý kritik. To platí najmä reakcie väčšiny ľudí je rozumný, keď čelí technickej písania. Ako bolo zdôraznené v príklade videorekordér vyššie, môžu byť technické písanie nepreniknuteľné pre koncového užívateľa. Ak je to prípad, je to preto, Kto napísal dokumentácie, sa neobťažoval zistiť svoje publikum a zapisovať na ich úroveň. Zdá sa zrejmé, miesto aby sa, ale ten, ktorý je často prehliadaná, že užívateľ svoje dokumenty, ktoré vytvárate, môže byť skutočne odborník. Samozrejme, ak chcete vytvoriť dokument o osobitnej odbornej výrobku pre určitú skupinu pokročilých používateľov (dobrým príkladom môže byť audit softvér pre počítačový systém správcu), potom budete musieť zložiť je to úplne inak, ako keď budete vytvárať napríklad technické príručky pre masovú softvérový trh počítače, ktorých cieľom je neskúsený domácich užívateľov. Jeden z prvé úlohy, ktoré musia splniť ešte predtým, ako dať pero do ruky, prstov na klávesnici, je zistiť, kto je užívateľom vašich dokumentov bude stavať a dokumenty zamerané na konkrétnu cieľovú skupinu (skupiny). Ak V tejto fáze máte pravdu, mal by sa vyhnúť svoje dokumenty odletovania celej miestnosti v annoyance! Plánovanie perfectionOnce ste označili cieľový trh pre dokumenty, ktoré budú vytvárať, budete potrebovať začať plánovať, ako budú dokumenty organizované. Tento proces je veľmi závislý na tom, čo dokumentáciu sa vyrába, ale môžete sledovať niekoľko hrubých nepísaným pravidlám. Po prvé, ak sú dokumenty na podporu najmä podrobný opis výrobkov (napr. počítačové aplikácie) si svoje špinavé ruky na to, ako rýchlo, ako len môžete. Tým, že skúma v detaile produktu, môžete formulovať plán útoku a začať skladať organizačnú štruktúru. Zatiaľ čo sa objavujú v detaile produktu, aby hojnej poznámky, ako robiť toto počas počiatočnej skúšobnej fázy môžu ušetriť čas, ktorý môže byť nevyhnutne potrebné, ak pracujete na termínu. Dokonca aj vo fáze plánovania, musíte zabezpečiť, je súdržnosť usporiadanie, organizačnú štruktúru dokumentu. Vyberte číslovanie dohovorov, odstavcové štýly, a vytvárať nápady pre hrubé rozloženia účely teraz, a ušetríte čas zásadný later.Let návrh inBefore potápanie strmhlav do vytvárania dokumentácie, návrh z každej časti prvej. To umožní zmeniť poradie v prípade, že dokumenty vytvárané nemajú logické 'toku', bez toho by vážne majú vplyv na projekt. Veľa technických dokumentov (najmä pre podrobnejšie výrobky) sa skladajú z mnohých (a v niektorých prípadoch prakticky bezpočet) iterácií. To je pretože výrobok posunov a zmeny v čase, a jeden z hlavných úloh technickej autora je držať krok s týmito zmenami, a zabezpečiť, aby všetci sú dobre zdokumentované. Dobré technické autori vždy presadzovať svoje dokumenty až toľko návrhy, tak v ľudských silách, rafinácia na každom návrhu, až do postavenia, v ktorom sú (a ich zamestnávateľov) je presvedčený, že dokumentácia je včasné, presné a verným odrazom výrobku alebo procesu, documents.The diabol je v detailAs už identifikované, je technická písomne vyzval, pretože to je technického rázu. Časť technického rázu má byť presné, a časť presnosť musí byť čo možno najpodrobnejšie, v ľudských silách. Iv prípade, že dokumenty, ktoré vytvárate, sú pre moderné a technologicky vyspelé užívateľské skupiny, musia byť v dokumentácii zamerať na detaily procese, alebo pri používaní výrobku. To môže byť ťažké dosiahnuť čin, ale keď píšete na vaše publikum. Nikdy sa predpokladať, že čitateľ vie niečo o výrobok alebo proces zdokumentovaný, ale v prípade, pokročilých / expert users aspoň zdravý rozum, aby uznali skutočnosť, že sa zrejme nemusí byť povedané, ako používať zariadenia, ktoré fungujú na dennej báze. Keď opisuje, ako vykonávať konkrétnu činnosť alebo úlohu, identifikovať každej fáze zapojený (počet sa ich, či to zodpovedá konvenciám typu dokumentu, ktoré vytvárate) a zabezpečiť správnosť toho, čo ste napísali test sami, alebo dokonca lepšie, laná dobrovoľníka rovnakej úrovne kvalifikácie ako koniec user.Choose správnym nástrojom pre jobAlthough je možné vytvárať technickú dokumentáciu pomocou pergamenu a krv, to nie je vhodné. Mnohých odborných Existujú softvérové aplikácie, ktoré vám pomôžu vytvoriť silný dokumentácie, a časť vašej povinností ako technický autor, zahŕňa výber správneho nástroja pre prácu. Z veľkej časti to závisí na povahe dokumentov vznikajúcich a charakter ich prípadné rozdelenie. Ak sa dokumenty možno poskytovať prostredníctvom internetu, je to určite cestou zvážiť. Na tento účel využiť balíčkov ako Flash MX a Dreamweaver na dosiahnutie tohto cieľa. Pre integrované online Pomocníka, môžete si vytvoriť ľubovoľné HTML dokumenty, prípadne zvoliť špeciálny program, napríklad RoboHelp alebo podobné. V prípade tlače na základe dokumentov, budete musieť zvoliť dostatočne silný softvérový balík pre prácu, čo vás bude hádzať na it.Many neskúsení autori technických okamžite obrátiť na Microsoft Word (ako je všadeprítomný mája obchodným a súkromné prostredie). Ak nie je v dokumentácii bude pod 150 strán, a viete, ako vytvárať šablóny a makrá, vyhnúť sa MS Word. Ako všetky technické autor vám povie, že má škaredé zvyky celej svojej vlastní, a môže byť často nestabilná balíček s ním pracovať. Ak vytvárate grafiky ťažké dokumentáciu, možno budete chcieť zvážiť Quark Xpress, alebo zvoliť potenciálne priemyslu lídrom na poli, Adobe FrameMaker. Akýkoľvek softvér, ktorý si vyberiete, musíte zabezpečiť, aby ste sa s neuveriteľne zdatní a to buď investovať do vzdelania, alebo pomocou jej deň čo deň čo deň! Communicate - to je to, čo sa oplatí robiť! Veľa ľudí vám povie, že vytvorenie technickej dokumentácie je únavné a opakujúce sa. Títo ľudia, sa mýli, a možná taky blbci. Aj keď môžete nájsť proces tvorby technickej dokumentácie 'nudný' (ak nemáte ste v zlej práci!) to nie je. Vytváranie kvalitných technickej dokumentácie je významnú etapu v umožniť ľuďom, aby riadne a správne používať technológiu. Hoci žiadny užívateľ prístup dokumentáciu, ktorú vytvoríte v rovnakým spôsobom, ako sa približuje román, môžete nakoniec pomôže im dosiahnuť toho, čo chcú dosiahnuť pomocou technológie. Nezáleží na tom, ako 'nudný' proces môže sa zdajú byť, čo umožňuje užívateľom dosiahnuť ich ciele čítanie dokumentov by vám návalu hrdosti a vlastne aj šťastie. Tak dlho, ako si spomeniete, pozitívne účinky, že technológia môže mať na životy ľudí, keď vytvárate svoje dokumenty, môžete komunikovať efektívnejšie, pretože budete šťastnejší v komunikatívny procese. V priebehu celého cyklu dokumentácie život, mali by ste sa snažiť spolupracovať s kolegami, ako často, ako je možné (ak ho používate). Nech si prečítať dokumenty, počúvať ich kritike, a upraviť svoje dokumenty (ak nemôžete tvrdiť, vaša rohu!). Technické autorom je venovaná komunikácii, uistite sa, že robíte, a nikdy nezabudnem, prečo sa vaše spolu komunikujú, a koho v dokumentoch themselves.Common chybám sa vyhnúť makingWhen tvorby technickej dokumentácie, existuje niekoľko fatálnych chýb, môžete vykonať. I keď v žiadnom prípade vyčerpávajúci, detaily tejto časti niektoré z viac Najčastejšie chyby novej autorov, aby, v nádeji, že budete zabrániť tomu, aby tiež: Byť povýšený - Hoci je technická dokumentácia by mala byť jasná, mala by byť nikdy dozor. Nie ste vytváranie dokumentov je čítať, ale blbci spotrebiteľov a klientov. By ste mali vždy napísať úrovne kvalifikácie na svoje publikum, ale bez ohľadu na to, akej technickej úrovni, ľudia sú na, oni nie sú blbci. Dokonca aj deti dostávajú urazil, keď podporovaný, nerobte rovnakú chybu s niekým, kto je platí svojho platu, dieťa alebo otherwise.Overuse humoru - Ľudia nečítajú technických dokumentov, ktoré budú baviť, ale čítať je v nádeji, že úspešne dokončenie procesu, alebo ťažby informácie. Ak to je relevantné pre koncového užívateľa, pokiaľ možno vyhnúť humor. Ak píšete knihu, jemné a dobré. Ak píšete manuál, vyhnúť humor, ako moru, rovnako ako viac často ako ne užívateľom chýbať vtip a jednoducho skončí sa odpor povýšený idiot, ktorý napísal documentation.Inconsistency - I vo fáze návrhu, mali by ste zabezpečiť, aby všetky prvky použitá v dokumente sú zhodné. To platí rovnako pre 'tón' dokumentu, pokiaľ ide o alokáciu to. Zabezpečiť dôsledné používanie zmyslov (prvá osoba, atď), rovnako ako rozloženie stránky, stránkovanie prvky, hlavičky a päty, a všetky ostatné textové čítaj elements.Proof - Do konca roka vytvoriť kus technickej dokumentácie, budete pravdepodobne zle z pohľadu na to. Na tom nezáleží. Na čom záleží, je to, čo listy kancelárii alebo doma, je presné. Na tento účel preukázania dokument čítať po celej svoje návrhy, a predtým, ako je distribuovaný dôkaz prečítať znova a znova a znova. Nespoliehajte na preklepov (nikdy práce) a ak sa môžete vyhnúť, nikdy nemali spoliehať iba na svoj vlastný úsudok. Získať dokument prečítať čo najviac párov očí čo možno ešte pred distribúciou, po tom všetkom, mohli by na mieste jedna vec, ktorú boli chýbajúce po vytvorení process.Conclusion / Nestyda samostatne promotionTechnical písanie nie je bez ohľadu na to, čo si môže myslieť, ľahká práca. To si vyžaduje odborné vedomosti, trpezlivosť a veľmi podivné směsice zručností. Rovnako ako akékoľvek iné zamestnanie, môžete sa naučiť, ako to urobiť, ale aj školné, ktoré sa nemusia nevyhnutne vás nejaké dobré sa na to. Ak chcete byť dobrý technický autor, musíte byť análny ešte kreatívne, ale zamerala komunikativní a flexibilné odborníka. To, ako ste si asi predstaviť, nie je jednoduchá úloha. Aj keď si myslíte, že môže vytvoriť technickej dokumentácie je jednoduché, vytvára presné, konzistentné a včasné dokumentácie vysokú obchodná norma veľmi náročné úlohy. Bez ohľadu na váš rozpočet, v dlhom období bude predstavovať významnú návratnosť investícií, ak najať odborníka. Koneckonců, budú môcť robiť v dňoch, čo trhať vlasy našej snahe uskutočniť počas niekoľkých týždňov, ak nie months.About AuthorOver rokov Mike Kemp bol zamestnaný ako novinár na voľnej nohe IT (pracovný publikácií, ako sú registri Namesfacesplaces, Focus a bezpečnosť Packetstorm), textár, videohry projektant, bezpečnostné audítor, web designer, grafik a IT tréner. Pracoval v rôznych externých a stále miesto pre malé (napr. dvaja muži a pes) spoločnostiam nadnárodných organizácií v celom Spojenom kráľovstve a Európe. Keď práve nepracuje na rôzne články, knihy, manuály, a rozmanité iné kópie pre klientov, Mike možno zvyčajne nájsť pracujúcich na rôznych nepublikované romány. Mal niekoľko jeho scenárov krátkych nezávislých produkčných spoločností, a je v súčasnosti pracuje na niekoľkých scripts.Mike celovečerný žije prevažne šťastne v strašlivě
Článok Zdroj: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster si html kód
Pridajte tento článok do svojich webových stránok sa!
Webmaster Pošlite svoj článok
Nie nutná registrácia! Vyplňte formulár a Váš článok je v Messaggiamo.Com Adresár!
