Päť najväčších chýb, že podniky, aby so zreteľom na technickú dokumentáciu
Videl som to znova a znova. Jedným z najčastejších nedostatkov, ktoré som videl v strojárskej spoločnosti-ba takmer univerzálne chybu-je nedostatok dobrej technickej dokumentácie. Niekto by mohol smiať, ako to sundat Malý detail, ale následky sú často ťažké. Spoločnosti celú budúcnosť môže byť stratená, alebo na základe množstva pozornosti, ktorú venujú tejto issue.Over rokov, som identifikoval päť problémov, ktoré som zistilo, že je bežná najmä pokiaľ ide o písanie technickej dokumentácie. Chcel by som, aby tieto myšlienky zdieľať s vami, v nádeji, že bráni ostatným pred pádom rovnaký paths.1. Ktoré nemajú žiadne užívateľské manualsDon't smiať. To sa môže zdať ako úplne základný omyl-absurdné, i-ale to je prekvapivo bežné. Som sa potýkala s radom spoločností, ktoré neposkytujú užívateľské príručky pre svoje výrobky, alebo ktorých príručky skeletally tenké alebo rokov zastarané. V skutočnosti by som odhadujú, že približne polovica malých strojárskych firiem, že som sa stretol, spadajú do tejto kategórie. (Samozrejme, človek málokedy narazí na tento problém pri nákupe off-the-shelf softvér alebo spotrebnej elektroniky. Medzi inžinieri aj keď je to na uzoufání známy príbeh.) Spomínam si, ako jeden inžinier mi povedal, prečo sa jeho spoločnosť neposkytla žiadne užívateľské príručky s ich výrobkami. V tiché tóny, povedal: "Je to preto, že nemáme žiadne peniaze písaním príručiek. Nie je to peniaze tvorby-venture, takže naše vedenie nechce strácať čas na to." Otrávený výraz vliezol do jeho tváre, potom sa naklonil a povedal: "Prišli sme o toľko zákazníkov, pretože nemáme slušné dokumentácie. Porozprávajte sa o tom penny-wise, libra-hlúpy!" Nejde len zákazníkov, ktorí trpia, keď Manuály sú nedostatočné, alebo ak nie sú priamo neexistujúce. A čo samotné zamestnanca? Čo sa stane, keď príde nový inžinier na palube, a musia sa naučiť rýchlo? Alebo čo sa stane, keď existujúce inžinieri potrebujú oboznámiť sebou viac neznámych aspektoch ich produktov? Užívateľské dokumentáciu, ak je riadne písomne, môže poskytnúť jemný a účinný spôsob, ako začleniť do rýchlosti. Bez nej, budú nútení spoľahnúť sa viac ťažko na iných inžinierov je vzdelávať, tak plytvaniu času všetkých zúčastnených strán. Týždne, ak nie mesiacov, cenné pracovnej sily môže byť premárnila v tejto fashion.2. Ktoré nemajú vlastné vnútorné documentationIt to nielen užívateľské dokumentáciu, že spoločnosti nevyhovujú na. Interná dokumentácia je často obeťou, rovnako ako spoločnosti, tahanice o uvoľnenie produktu. V zhone, aby ich výrobky na trh, firmy často nechávajú svoje vnútorné konštrukcie dokumenty spadajú do beznádejne wayside.It nepomôže, že programátori a inžinieri sú preslávení s nevýrazného komunikačné zručnosti, a že dokumentácia je úloha, ktorá požívajú len zriedka. Som sa stretol veľa softvérových firiem, napríklad softvér, ktorých návrhy boli nezvládnuteľný chaos kvôli ich nedostatku architektonických dokumentov, popis rozhrania a in-code komentáre. Bohužiaľ, videl som podobné problémy, pokiaľ ide o mechanické konštrukcie, elektronické vzory, výrobné postupy? na čo si it.I 'som hovoril s inžiniermi, ktorých podniky majú už buď pod, alebo boli zošmyknú na pokraji. Takmer vždy, nedostatočná dokumentácia bola hlavným faktorom v takých situations.I vždycky hovorím svoje šéfmi a co-robotníci, "Chcem sa uistiť, že moja práca je sakramentsky dobre zdokumentované. Kdybych opustiť spoločnosť, alebo či zomriem pri dopravnej nehode, pretože ja chcem, aby sa ubezpečil, že táto spoločnosť môže na pochode bezo mňa. "To by malo byť jedným z hlavných dôvodov, za vedenie dokumentácie-dôkladne, aby sa ubezpečil, že Spoločnosť nebude ochromenie akejkoľvek osoby absence.Unfortunately, veľa zamestnancov sa naopak nehne. Oni úmyselne šetriť na dokumentáciu, v domnení, že to zabezpečí im nejaké istoty zamestnania-a niekedy to funguje. Avšak, šikovný zamestnávateľ vie, že dokumenty, inžinier, ktorý tiež stojí za to oveľa viac, ako iný inžinier, ktorý drží svoje karty blízko vestu. Neskôr môže byť zásadný v krátkodobom horizonte, ale nakoniec, je to dlho-termín liability.3. Zabudol niečí audienceThis problém, často sa vyskytuje pri tvorbe užívateľskej dokumentácie. Programátori a inžinieri často zabúdajú, že ich príručky bude čítať od ľudí, ktorí sú oboznámení s ich výrobkami, alebo ktorí nemajú rovnaké technické zručnosti. Spomínam si na jedného spoločnosti najmä-stroj správca spoločnosti na západnom pobreží. Ich "užívateľská príručka" bol hrozný Hodge-podge skratiek, nedefinované pojmy a zdanlivo náhodnej myšlienky, asi tucet postupy uvedené bez konkrétneho poradia. Ich užívateľskej dokumentácii chýbajú základné informácie, ako napr ako začať radič hore, alebo ako ju zastaviť v prípade núdze-kritické informácie, že každý nováčik používateľ očakávať od manual.A Souvisejícím problémom je neschopnosť používať vlastný jazyk. Zoberme si prípad, kedy veľa čitateľov nie sú rodenými hovorcami angličtiny-znamená, že pri uvádzaní na trh výrobkov v Európe alebo Ázii, alebo pri písaní montážne postupy pre cudzie-narodený továrenským robotníkom. V takýchto prípadoch môže byť nevyhnutné, aby jazyk pomerne jednoduchý. Ak to nie je možné-znamená, že pri prerokúvaní komplexné informácie, ktoré vyžadujú veľkú presnosť-často možno kompenzovať pridaním niektorých vhodne zvolenej-grafy, diagramy alebo fotografie. Buď prístup môže byť užitočné pri vytváraní zložitých textov trochu ľahšie absorb.4. Nie je vhodne graphicIt je nepopierateľne clichÃÆ'Ã,  ©, ale pravda, však nejde-vydá za tisíce slov. Podobne manuál, ktorý je rozumné využívanie obrazov a schém bude oveľa ľahšie pochopiť, ako ten, ktorý je zložený výlučne z textu descriptions.Some Považujem to za detinské a zbytočné. Ja nie, a my Skúsenosti ukázali, že väčšina užívateľov ocenia majú tieto vizuálne sprievodca. Pamätajte si, bez ohľadu na to, ako sofistikované čitateľa sú, sú to stále ľudia. Dokonca aj inteligentné, inak opatrný čitateľ náhodne chýbajú niektoré dôležité detaily, obzvlášť keď naliehali time.5. Neusilujú o excellenceIt zaujímavé vidieť, ako sa programátori a inžinieri môžu snažiť o vynikajúce výsledky v mnohých aspektoch svojej práce, ale mať presne opačný prístup, pokiaľ ide o dokumentáciu. "Kto sa zaujíma o slová vlastne je?" Počul som veľa inžinierov povedať. "Nie sme písať poéziu alebo scenáre tu. Dôležité je, že dokumentácia musí byť technicky správne. "To je strašne krátky-slabozrakých názor. technickú presnosť, je veľmi dôležité, ale rovnako tak sú prezentácie a štýl. Málo inžinieri by počúvať uchádzačov o zamestnanie, ktorý ukazuje sa v župan a papuče, alebo súdneho sporu advokát, ktorý hovorí ako dievča-doline, a predsa tak nejako tí istí technici očakávajú, že ich kolegovia Technici (alebo ešte horšie, zákazník!) sa pachtit so stránkami meandrující, zle formulovaný text. Dokonca aj veci, ako je základná pravopisu, gramatiky a korektúry sú často považované za obyčajnú nepríjemností-triviálne detaily, ktoré stoja za to nič viac, ako zbežný pohľad. (K mojej úľave, nemám objavili také názory na mojom mieste zamestnania. Rád by som povedať, či niekto myslí, že by som si sťažoval o ľuďoch, ktoré som pracovať! Nie, som zistil, že sme všetci oceniť hodnotu excelentnosti, pre ktoré som vždy vďačný. Ale ja som odbočiť.) Pamätajte si: Pri písaní na jeden kolega Technici, je potrebné mať na pamäti, že musia často absorbujú obsiahle množstvo informácií vo veľmi nízke množstvo času. Kedy písanie pre laikov, jeden by mal urobiť text ako jemný a ľahko stráviteľné, ako je to možné, inak sa stanú stratil v oceáne geekspeak. Či tak alebo onak, je dávať trochu viac úsilia v oblasti eleganciu a štýl urobiť svet difference.I Nepôjdem do podrobností o tom, čo tvorí dobré písanie techniku, pretože to by bolo nad rámec tohto textu. Stačí povedať, že dobrý programátor, alebo inžinier by mali zabezpečiť, aby jeho písanie je čitateľný a dobre-organizovaný, a že to tečie hladko od jedného témy na another.I by bol nadšený k nevíře, keď som nevidel inú nedbanlivý manuálne, alebo keď som nikdy nepočula, iný príbeh spoločnosti kolapsu kvôli non-existujúcej dokumentácie. Beznádejné fantázie? Možno. Stále dúfam, že niektorí Technici tam bude čítať túto správu, a že to bude trvať heart.About AuthorV. Bérbe Velasco má doktorát v odbore elektrotechniky a bol plaviacich sa jeho obchodný takmer desať rokov. Počas tej doby sa opätovne objavil význam dobrej technickej písanie, a úskalia, ktoré môžu nastať od ignorovanie jeho value.Dr. Velasco v súčasnej dobe pracuje ako vedúci elektrických a softvérový inžinier pre bunkové Technology Limited (http://www.immunospot.com, http://www.elispot-analyzers.de), biotechnologické spoločnosti v Clevelande,
Č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!
