Technická psaní pro vyděšené
IntroductionSometimes to může být za společností nebo jednotlivců rozpočtu najmout profesionální spisovatel řešit jejich technické dokumentaci. I když se v ideálním světě, všechny technické dokumentace by měly být vyráběny od vysoce vzdělaných odborníků, bohužel nežijeme v ideálním. Stejným způsobem, že mnoho lidí se pokusí opravit vlastní domácí spotřebiče, se mnoho lidí snaží napsat kvalitní technické dokumenty. Stejně jako si hrát s toustovač může vyústit v elektrickém křesle, pokouší se psát technické dokumenty od nuly a bez předchozího doporučení bude nakonec vést k selhání. Jako hrubé orientační pravidlo vždy byste měli hledat zaměstnávat specialisty, ale pokud z nějakého důvodu nemůžete a jste chudí nešťastné, že má povinnosti dokumentace vnuceného jim, nezoufejte. Tento stručný průvodce popisuje některé z klíčových dovedností, budete třeba, aby do svého psaní, technické úmluv, které mají být vědomi, softwarové balíky, můžete zvážit, a jednoznačné věci, aby se zabránilo. Doufejme, že i když jste nikdy nenapsal větu ve svém životě o ničem nejasně technické budete mít přinejmenším, širší obrázek o tom, co se technické psaní entails.What Technické psaní? Technické psaní nijak překvapivě dost, se odkazuje na psaní, které je technické. I když to může zdát jako klamný definice, je to důležité, to pamatovat. Příliš mnoho technických autoři dělají tu chybu, tvorba dokumentace, která je buď příliš technické, nebo příliš 'literární'. Dobrém technickém autor by měl být schopen nastavit rovnováhu mezi těmito dvěma, aby vyhovovalo konečnému uživateli dokumentace. Technická psaní je hodně rád čerstvý vzduch, všudypřítomná a přitom do značné míry neviditelný. V kabelové divný svět, ve které se nacházíme, technické psaní je všude. Software, manuály, uživatelské příručky pro domácí spotřebiče, naučná letáky, e-maily, dopisy, zprávy, technické novinky zprávy, statistiky a životopisy na televizní sportovní ukazuje všechny jsou příklady technické psaní, na které jsou lidé vystaveni na denní bázi. Jestliže jste někdy zkoušeli programovat nastavení času na záznam domácího videa a hodil přes ruční pokoj s odporem, jste hodil kus technického psaní (i když samozřejmě ne moc dobrý!). Mnohokrát technická literatura je vyráběn s spisovatelé nejsou dost velké pochopení technologie, nebo techniky, které postrádají schopnost psát. Jako perspektivní technické autor musíte šlapat velmi jemné linie jsou technicky své odborné znalosti z oboru (y), stejně jako 'dobrý' spisovatel (jako na rozdíl od 'špatné' spisovatelé, kteří obvykle se nachází přepadení sladký staré dámy, nebo tak něco). Technická dokumentace se obvykle vyrábí pro dvě odlišné skupiny uživatelů, a to odborné úrovni uživatelů a naivní uživatele. Jako Technické autor jeden z vašich prvních úkolů je vyřešit to, co diváci psaní pro, což mě přivádí k obratně: Vím o tvých foeAs staré clichÃÆ'Ã,  © platí, každý kritik. To platí zejména reakce většiny lidí je rozumný, když čelí technické psaní. Jak bylo zdůrazněno v příkladu videorekordér výše, mohou být technické psaní neprostupných pro koncového uživatele. Pokud je to případ, je to proto, Kdo napsal dokumentace, se neobtěžoval zjistit své publikum a zapisovat na jejich úroveň. Zdá se zřejmé, místo aby se, ale ten, který je často přehlížena, že uživatel své dokumenty, které vytváříte, může být skutečně odborník. Samozřejmě, pokud chcete vytvořit dokument o zvláštní odborné výrobku pro určitou skupinu pokročilé uživatele (dobrým příkladem může být audit software pro počítačový systém správce), pak budete muset složit je to úplně jinak, než když budete vytvářet například technické příručky pro masovou softwarový trh počítače, jejichž cílem je nezkušený domácí uživatele. Jeden z první úkoly, které musí splnit ještě předtím, než dát pero do ruky, prstů na klávesnici, je zjistit, kdo je uživatelem vašich dokumentů bude stavět a dokumenty zaměřené na konkrétní cílovou skupinu (skupiny). Pokud V této fázi máte pravdu, měl by se vyhnout své dokumenty vymrštění celé místnosti v annoyance! Plánování perfectionOnce jste označili cílový trh pro dokumenty, které budou vytvářet, budete potřebovat začít plánovat, jak budou dokumenty organizovány. Tento proces je velmi závislý na tom, co dokumentaci se vyrábí, ale můžete sledovat několik hrubých nepsaným pravidlům. Za prvé, pokud jsou dokumenty na podporu zejména podrobný popis výrobků (např. počítačové aplikace) si své špinavé ruce na to, jak rychle, jak jen můžete. Tím, že zkoumá v detailu produktu, můžete formulovat plán útoku a začít skládat organizační strukturu. Zatímco se objevují v detailu produktu, aby hojné poznámky, jak dělat toto během počáteční experimentální fáze mohou ušetřit čas, který může být nezbytně nutné, pokud pracujete na termínu. Dokonce i ve fázi plánování, musíte zajistit, je soudržnost uspořádání, organizační strukturu dokumentu. Zvolte číslování úmluv, odstavcové styly, a vytvářet nápady pro hrubé rozvržení účely nyní, a ušetříte čas zásadní later.Let návrh inBefore potápění střemhlav do vytváření dokumentace, návrh z každé části první. To umožní změnit pořadí v případě, že dokumenty vytvářeny nemají logické 'toku', aniž by vážně mají dopad na projekt. Mnoho technických dokumentů (zejména pro podrobnější výrobky) se skládají z mnoha (a v některých případech prakticky bezpočet) iterací. To je protože výrobek posunů a změny v čase, a jeden z hlavních úkolů technické autora je držet krok s těmito změnami, a zajistit, aby všichni jsou dobře zdokumentovány. Dobré technické autoři vždy prosazovat své dokumenty až tolik návrhy, jak v lidských silách, rafinace na každém návrhu, až do postavení, v němž jsou (a jejich zaměstnavatele) je přesvědčen, že dokumentace je včasné, přesné a věrným odrazem výrobku nebo procesu, documents.The ďábel je v detailAs již identifikovány, je technická písemně vyzval, protože to je technického rázu. Část technického rázu má být přesné, a část přesnost musí být co nejpodrobnější, v lidských silách. Iv případě, že dokumenty, které vytváříte, jsou pro moderní a technologicky vyspělé uživatelské skupiny, musí být v dokumentaci zaměřit na detaily procesu, nebo při používání výrobku. To může být obtížné dosáhnout čin, ale když píšete na vaše publikum. Nikdy se předpokládat, že čtenář ví něco o výrobek nebo postup zdokumentován, ale v případě, pokročilých / expert users přinejmenším zdravý rozum, aby uznaly skutečnost, že se zřejmě nemusí být řečeno, jak používat zařízení, které fungují na denní bázi. Když popisuje, jak provádět konkrétní činnost nebo úkol, identifikovat každé fázi zapojen (počet se jich, jestli to odpovídá konvencím typu dokumentu, které vytváříte) a zajistit správnost toho, co jste napsali test sami, nebo dokonce lepší, lana dobrovolníka stejné úrovně kvalifikace jako konec user.Choose správným nástrojem pro jobAlthough je možné vytvářet technickou dokumentaci pomocí pergamenu a krev, to není vhodné. Mnoha odborných Existují softwarové aplikace, které vám pomohou vytvořit silný dokumentace, a část vaší povinností jako technický autor, zahrnuje výběr správného nástroje pro práci. Z velké části to záleží na povaze dokumentů vznikajících a charakter jejich případné rozdělení. Pokud se dokumenty lze poskytovat prostřednictvím internetu, je to jistě cestou zvážit. K tomuto účelu využít balíčků jako Flash MX a Dreamweaver k dosažení tohoto cíle. Pro integrované online nápovědy, můžete si vytvořit libovolné HTML dokumenty, případně zvolit speciální program, například RoboHelp nebo podobné. V případě tisku na základě dokumentů, budete muset zvolit dostatečně silný softwarový balík pro práci, co vás bude házet na it.Many nezkušení autoři technických okamžitě obrátit na Microsoft Word (jak je všudypřítomný května obchodním a soukromé prostředí). Není-li v dokumentaci bude pod 150 stran, a víte, jak vytvářet šablony a makra, vyhnout se MS Word. Jako všechny technické autor vám řekne, že má ošklivé zvyky celé své vlastní, a může být často nestabilní balíček s ním pracovat. Pokud vytváříte grafiky těžké dokumentaci, možná budete chtít zvážit Quark Xpress, nebo zvolit potenciálně průmyslu lídrem na poli, Adobe FrameMaker. Jakýkoliv software, který si zvolíte, musíte zajistit, abyste se s neuvěřitelně zdatní a to buď investovat do vzdělání, nebo pomocí jí den co den co den! Communicate - to je to, co se vyplatí dělat! Mnoho lidí vám řekne, že vytvoření technické dokumentace je únavné a opakující se. Tito lidé, se mýlí, a možná taky blbci. I když můžete najít proces vytváření technické dokumentace 'nudný' (pokud nemáte jste ve špatné práci!) to není. Vytváření kvalitních technické dokumentace je významnou etapu v umožnit lidem, aby řádně a správně používat technologii. Ačkoliv žádný uživatel přístup dokumentaci, kterou vytvoříte v stejným způsobem, jak se přibližuje román, můžete nakonec pomůže jim dosáhnout toho, čeho chtějí dosáhnout pomocí technologie. Nezáleží na tom, jak 'nudný' proces může se zdají být, což umožňuje uživatelům dosáhnout jejich cílů čtení dokumentů by vám návalu hrdosti a vlastně i štěstí. Tak dlouho, jak si vzpomenete, pozitivní účinky, že technologie může mít na životy lidí, když vytváříte své dokumenty, můžete komunikovat efektivněji, protože budete šťastnější v komunikativní procesu. V průběhu celého cyklu dokumentace život, měli byste se snažit spolupracovat s kolegy, jak často, jak je možné (pokud jej používáte). Ať si přečíst dokumenty, naslouchat jejich kritice, a upravit své dokumenty (pokud nemůžete tvrdit, vaše rohu!). Technické autorem je věnována komunikaci, ujistěte se, že děláte, a nikdy nezapomenu, proč se vaše spolu komunikují, a koho v dokumentech themselves.Common omylům se vyhnout makingWhen vytváření technické dokumentace, existuje několik fatálních chyb, můžete provést. I když v žádném případě vyčerpávající, detaily této části některé z více Nejčastější chyby nové autory, aby, v naději, že budete zamezit tomu, aby také: Být povýšený - Ačkoli je technická dokumentace by měla být jasná, měla by být nikdy dozor. Nejste vytváření dokumentů je číst, ale blbci spotřebitelů a klientů. Byste měli vždy napsat úrovně kvalifikace na své publikum, ale bez ohledu na to, jaké technické úrovni, lidé jsou na, oni nejsou blbci. Dokonce i děti dostávají urazili, když podporovaný, nedělejte stejnou chybu s někým, kdo je platí svého platu, dítě nebo otherwise.Overuse humoru - Lidé nečtou technických dokumentů, které budou bavit, ale číst je v naději, že úspěšně dokončení procesu, nebo těžby informace. Pokud to je relevantní pro koncového uživatele, pokud možno vyhnout humor. Pokud píšete knihu, jemné a dobré. Pokud píšete manuál, vyhnout humor, jako moru, stejně jako více často než ne uživatelům chybět vtip a prostě skončí odpor povýšený idiot, který napsal documentation.Inconsistency - I ve fázi návrhu, měli byste zajistit, aby všechny prvky použitá v dokumentu jsou shodné. To platí stejně pro 'tón' dokumentu, pokud jde o rozvržení to. Zajistit důsledné používání smyslů (první osoba, atd.), stejně jako rozvržení stránky, stránkování prvky, záhlaví a zápatí, a všechny ostatní textové číst elements.Proof - Do konce roku vytvořit kus technické dokumentace, budete pravděpodobně špatně z pohledu na to. Na tom nezáleží. Na čem záleží, je to, co listy kanceláři nebo doma, je přesné. Za tímto účelem prokázání dokument číst po celé své návrhy, a předtím, než je distribuován důkaz přečíst znovu a znovu a znovu. Nespoléhejte na překlepů (nikdy práce) a pokud se můžete vyhnout, nikdy neměli spoléhat pouze na svůj vlastní úsudek. Získat dokument přečíst co nejvíce párů očí co možná ještě před distribucí, po tom všem, mohli by na místě jedna věc, kterou byly chybějící po vytvoření process.Conclusion / Nestyda samostatně promotionTechnical psaní není bez ohledu na to, co si může myslet, snadná práce. To vyžaduje odborné znalosti, trpělivost a velmi podivné směsice dovedností. Stejně jako jakékoli jiné zaměstnání, můžete se naučit, jak to udělat, ale i školné, které se nemusí nutně vás nějaké dobré se na to. Chcete-li být dobrý technický autor, musíte být anální ještě kreativní, ale zaměřila komunikativní a flexibilní odborníka. To, jak jste si asi představit, není jednoduchý úkol. I když si myslíte, že může vytvořit technické dokumentace je snadné, vytváří přesné, konzistentní a včasné dokumentace vysokou obchodní norma velmi náročné role. Bez ohledu na váš rozpočet, v dlouhém období bude představovat významnou návratnost investic, pokud najmout odborníka. Koneckonců, budou moci dělat ve dnech, co trhat vlasy naší snaze uskutečnit během několika týdnů, ne-li months.About AuthorOver let Mike Kemp byl zaměstnán jako novinář na volné noze IT (pracovní publikací, jako jsou rejstříku Namesfacesplaces, Focus a bezpečnost Packetstorm), textař, videohry projektant, bezpečnostní auditor, web designer, grafik a IT trenér. Pracoval v různých externích a stálé místo pro malé (např. dva muži a pes) společnostem nadnárodních organizací v celém Spojeném království a Evropě. Když zrovna nepracuje na různé články, knihy, manuály, a rozmanité jiné kopie pro klienty, Mike lze obvykle nalézt pracujících na různých nepublikované romány. Měl několik jeho scénářů krátkých nezávislých produkčních společností, a je v současné době pracuje na několika scripts.Mike celovečerní žije převážně šťastně v strašlivě
Článek Zdroj: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster si html kód
Přidejte tento článek do svých webových stránek se!
Webmaster Zašlete svůj článek
Ne nutná registrace! Vyplňte formulář a váš článek je v Messaggiamo.Com Adresář!
