Pět největších chyb, že podniky, aby s ohledem na technickou dokumentaci
Viděl jsem to znovu a znovu. Jedním z nejčastějších nedostatků, které jsem viděl ve strojírenské společnosti-ba téměř univerzální chybu-je nedostatek řádné technické dokumentace. Někdo by mohl smát, jak to sundat Malý detail, ale následky jsou často těžké. Společnosti celou budoucnost může být ztracena, nebo na základě množství pozornosti, kterou věnují této issue.Over let, jsem identifikoval pět problémů, které jsem zjištěno, že je běžná zejména pokud jde o psaní technické dokumentace. Chtěl bych, aby tyto myšlenky sdílet s vámi, v naději, že brání ostatním před pádem stejný paths.1. Které nemají žádné uživatelské manualsDon't smát. To se může zdát jako zcela základní omyl-absurdní, i-ale to je překvapivě běžné. Jsem se potýkala s řadou společností, které neposkytují uživatelské příručky pro své výrobky, nebo jejichž příručky skeletally tenké nebo let zastaralé. Ve skutečnosti bych odhadují, že přibližně polovina malých strojírenských firem, že jsem se setkal, spadají do této kategorie. (Samozřejmě, člověk málokdy narazí na tento problém při nákupu off-the-shelf software nebo spotřební elektroniky. Mezi inženýři i když je to k uzoufání známý příběh.) Vzpomínám si, jak jeden inženýr mi řekl, proč se jeho společnost neposkytla žádné uživatelské příručky s jejich výrobky. V tiché tóny, řekl: "Je to proto, že nemáme žádné peníze psaním příruček. Není to peníze tvorby-venture, takže naše vedení nechce ztrácet čas na to." Otrávený výraz vlezl do jeho obličeje, pak se naklonil a řekl: "Přišli jsme o tolik zákazníků, protože nemáme slušné dokumentace. Promluvte si o tom penny-wise, libra-hloupý!" Nejde jen zákazníků, kteří trpí, když Manuály jsou nedostatečné, nebo nejsou-li přímo neexistující. A co samotné zaměstnance? Co se stane, když přijde nový inženýr na palubě, a musí se naučit rychle? Nebo co se stane, když stávající inženýři potřebují seznámit sebou více neznámých aspektech jejich produktů? Uživatelské dokumentaci, je-li řádně písemně, může poskytnout jemný a účinný způsob, jak začlenit do rychlosti. Bez ní, budou nuceni spolehnout se více těžce na jiných inženýrů je vzdělávat, tak plýtvání času všech zúčastněných stran. Týdny, ne-li měsíců, cenné pracovní síly může být promarněna v této fashion.2. Které nemají vlastní vnitřní documentationIt to nejen uživatelské dokumentaci, že společnosti nesplňují na. Interní dokumentace je často obětí, stejně jako společnosti, tahanice o uvolnění produktu. Ve spěchu, aby jejich výrobky na trh, firmy často nechávají své vnitřní konstrukce dokumenty spadají do beznadějně wayside.It nepomůže, že programátoři a inženýři jsou proslulí s nevýrazného komunikační dovednosti, a že dokumentace je úkol, který požívají jen zřídka. Jsem se setkal mnoho softwarových firem, například software, jejichž návrhy byly nezvladatelný chaos kvůli jejich nedostatku architektonických dokumentů, popis rozhraní a in-code komentáře. Bohužel, viděl jsem podobné problémy, pokud jde o mechanické konstrukce, elektronické vzory, výrobní postupy? na co si it.I 'jsem mluvil s inženýry, jejichž podniky mají buď už pod, nebo byly sklouzávají na pokraji. Téměř vždy, nedostatečná dokumentace byla hlavním faktorem v takových situations.I vždycky říkám své šéfy a co-dělníci, "Chci se ujistit, že moje práce je zatraceně dobře zdokumentováno. Kdybych opustit společnost, nebo jestli zemřu při dopravní nehodě, protože já chci, aby se ujistil, že tato společnost může na pochodu beze mě. "To by mělo být jedním z hlavních důvodů, za vedení dokumentace-důkladně, aby se ujistil, že Společnost nebude ochromení jakékoli osoby absence.Unfortunately, mnoho zaměstnanců se naopak nehne. Oni úmyslně šetřit na dokumentaci, v domnění, že to zajistí jim nějaké jistoty zaměstnání-a někdy to funguje. Nicméně, chytrý zaměstnavatel ví, že dokumenty, inženýr, který také stojí za to mnohem více, než jiný inženýr, který drží své karty blízko vestu. Později může být zásadní v krátkodobém horizontu, ale nakonec, je to dlouho-termín liability.3. Zapomněl něčí audienceThis problém, často se vyskytuje při tvorbě uživatelské dokumentace. Programátoři a inženýři často zapomínají, že jejich příručky bude číst od lidí, kteří jsou obeznámeni s jejich výrobky, nebo kteří nemají stejné technické dovednosti. Vzpomínám si na jednoho společnosti zejména-stroj správce společnosti na západním pobřeží. Jejich "uživatelská příručka" byl hrozný Hodge-podge zkratek, nedefinované pojmy a zdánlivě náhodné myšlenky, asi tucet postupy uvedené bez konkrétního pořadí. Jejich uživatelské dokumentaci chybí základní informace, jako např. jak začít řadič nahoru, nebo jak ji zastavit v případě nouze-kritické informace, že každý nováček uživatel očekávat od manual.A Souvisejícím problémem je neschopnost používat vlastní jazyk. Vezměme si případ, kdy mnoho čtenářů nejsou rodilými mluvčími angličtiny-znamená, že při uvádění na trh výrobků v Evropě nebo Asii, nebo při psaní montážní postupy pro cizí-narozený továrním dělníkům. V takových případech může být nezbytné, aby jazyk poměrně jednoduchý. Pokud to není možné-znamená, že při projednávání komplexní informace, které vyžadují velkou přesnost-lze často kompenzovat přidáním některých vhodně zvolené-grafy, diagramy nebo fotografie. Buď přístup může být užitečné při vytváření složitých textů trochu snazší absorb.4. Není vhodně graphicIt je nepopiratelně clichÃÆ'Ã,  ©, ale pravda, nicméně nejde-vydá za tisíce slov. Podobně manuál, který je rozumné využívání obrazů a schémat bude mnohem snazší pochopit, než ten, který je složen výhradně z textu descriptions.Some Považuji to za dětinské a zbytečné. Já ne, a my Zkušenosti ukázaly, že většina uživatelů ocení mají tyto vizuální průvodce. Pamatujte si, bez ohledu na to, jak sofistikované čtenáře jsou, jsou to stále lidé. Dokonce i inteligentní, jinak opatrný čtenář náhodně chybí některé důležité detaily, obzvláště když naléhali time.5. Neusilují o excellenceIt zajímavé vidět, jak se programátoři a inženýři mohou usilovat o vynikající výsledky v mnoha aspektech své práce, ale mít přesně opačný přístup, pokud jde o dokumentaci. "Kdo se zajímá o slova vlastně je?" Slyšel jsem mnoho inženýrů říct. "Nejsme psát poezii nebo scénáře zde. Důležité je, že dokumentace musí být technicky správné. "To je hrozně krátký-slabozraké názor. technickou přesnost, je velmi důležité, ale stejně tak jsou prezentace a styl. Málo inženýři by poslouchat uchazeče o zaměstnání, který ukazuje se v župan a pantofle, nebo soudního sporu advokát, který mluví jako dívka-údolí, a přesto tak nějak titíž technici očekávají, že jejich kolegové Technici (nebo ještě hůře, zákazník!) se pachtit se stránkami meandrující, špatně formulovaný text. Dokonce i záležitosti, jako je základní pravopisu, gramatiky a korektury jsou často považovány za pouhou nepříjemností-triviální detaily, které stojí za to nic víc, než zběžný pohled. (K mé úlevě, nemám objevily takové názory na mém místě zaměstnání. Rád bych říct, ať někdo myslí, že bych si stěžoval o lidech, které jsem pracovat! Ne, jsem zjistil, že jsme všichni ocenit hodnotu excelence, pro které jsem vždycky vděčný. Ale já jsem odbočit.) Pamatujte si: Při psaní na jeden kolega Technici, je třeba mít na paměti, že musí často absorbují obsáhlé množství informací ve velice nízké množství času. Kdy psaní pro laiky, jeden by měl učinit text jako jemný a snadno stravitelné, jak je to možné, jinak se stanou ztratil v oceánu geekspeak. Ať tak či onak, je dávat trochu víc úsilí v oblasti eleganci a styl učinit svět difference.I Nepůjdu do podrobností o tom, co tvoří dobré psaní techniku, neboť to by bylo nad rámec tohoto textu. Stačí říct, že dobrý programátor, nebo inženýr by měly zajistit, aby jeho psaní je čitelný a dobře-organizovaný, a že to teče hladce od jednoho tématu k another.I by byl nadšený k nevíře, když jsem neviděl jinou nedbalý manuální, nebo když jsem nikdy neslyšela, jiný příběh společnosti kolapsu kvůli non-existující dokumentace. Beznadějné fantazie? Možná. Stále doufám, že někteří Technici tam bude číst tuto zprávu, a že to bude trvat heart.About AuthorV. Berba Velasco má doktorát v oboru elektrotechniky a byl plavící se jeho obchodní téměř deset let. Během té doby se opakovaně objevil význam dobré technické psaní, a úskalí, které mohou nastat od ignorování jeho value.Dr. Velasco v současné době pracuje jako vedoucí elektrických a softwarový inženýr pro buněčné Technology Limited (http://www.immunospot.com, http://www.elispot-analyzers.de), biotechnologické společnosti v Clevelandu,
Č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ář!
