В петте най-големи грешки, които компаниите правят по отношение на техническата документация
Съм го виждал, отново и отново. Един от най-честите слабости, които съм виждал в инженерингови фирми-наистина, почти универсална вина-е липсата на подходяща техническа документация. Някои ще се смея това разстояние като малки детайли, но последиците са често тежки. цялото бъдеще компанията може да се направи или изгубени въз основа на количеството на внимание, които плащат, за това issue.Over годините, аз идентифицирани пет проблемите, които съм установено, че е особено разпространено, когато става дума за писмено техническата документация. Бих искал да споделя тези мисли с вас, с надеждата да предотврати попадането на други по същия paths.1. Не е като всеки потребител manualsDon't смях. Това може да изглежда като доста основни грешка-абсурдно, дори-но е учудващо често. Аз бях срещат много фирми, които не предоставят ръководството за своите продукти, или чиито ръководства са skeletally тънки или години от датата. В действителност, бих изчисляват, че около половината от малките фирми инженерство, че съм срещани попадат в тази категория. (Разбира се, едно рядко среща този проблем при покупка радио-и телевизионни шелф, или софтуер за потребителска електроника. Сред инженерите все пак, това е Потискащо позната история.) Спомням си как един механик ми каза защо неговата компания не предостави никакви ръководство с техните продукти. В тихо тонове, той каза: "Това е така, защото ние не правим никакви пари от писане ръководство. Това не е печелене на пари предприятие, така че нашето ръководство не иска да губи време по този въпрос." Един раздразнен израз промъкнали в неговата лицето, след което той наведе по-близо и каза: "Ние сме загубили толкова много клиенти, защото не са достойни документация. Говорете за се пени-мъдър, паунд-глупави!" Това не е само за клиенти, които страдат, когато ръководство са недостатъчни или несъществуващи. Ами самите служители? Какво се случва, когато един нов инженер идва на борда, и трябва да се научи бързо? Или какво се случва, когато съществуващите инженери трябва да се запознаят себе си повече с непознати аспекти на техните продуктови линии? В документацията за потребителя, ако са правилно написани, може да даде лек и ефикасен начин за обединяване на висока скорост. Без нея те ще бъдат принудени да разчитат по-голяма степен от други инженери да ги образоват, като по този начин губи по време на съответната всички. Седмици, ако не и месеци на ценни работна ръка може да се пропилява в тази fashion.2. Не е като с подходящи вътрешни documentationIt на не само на ръководството, че дружествата попадат кратко на. Вътрешна документация е често едно произшествие, както и, тъй като фирмите надпревара за освобождаването на продукта. В бързането си да въвеждат продукти на пазара, дружеството често споделят своите вътрешни документи попадат дизайн безнадеждно от wayside.It не помогне, че програмисти и инженери са известни за това, че незначителното комуникативни умения, както и че документацията е задача, която те рядко се ползват. Аз бях срещат много софтуерни компании, например, чийто софтуер проекти са една непреодолима каша, поради липсата на архитектурни документи, описани интерфейс и по-код коментари. За съжаление, аз съм виждал подобни проблеми, когато става дума за механично дизайн, електронен дизайн, производство процедури? ти името си it.I "говори за инженери, чиито фирми са били скрили, или са били teetering на ръба. Почти неизменно, липсата на достатъчно документация е основен фактор в тези situations.I винаги казвам на моите шефове и колеги, "Аз искам да се уверя, че работата ми е оправя добре документирани. Ако напуснат фирмата, или да умра в автомобилна катастрофа, защото аз искам да се уверя, че това дружество може март без мен. "Това трябва да бъде една от основните причини зад водене цялостна документация-за да сте сигурни, че дружеството няма да бъдат осакатени от всяко лице absence.Unfortunately, много служители обратната халс. Те нарочно скъп за документацията, смятайки, че това ще им осигури около сигурността на работното място и Понякога това работи. Въпреки това, един умен работодател знае, че един инженер, който документ и е на стойност много повече от друг инженер, който държи картите близо до неговата жилетка. Последното може да бъде от съществено значение в краткосрочен план, но в крайна сметка, той е една дългосрочна liability.3. Забравянето audienceThis нечии проблем често се среща при разработването на документация за потребителя. Програмисти и инженери, често забравяме, че техните ръководства ще се четат от хора, които не са запознати с техните продукти, или които не притежават същите технически умения. Спомням си една компания по-специално-компания, машинен контролер, на западния бряг. Техните "ръководство" е ужасно селяк-podge на съкращенията, неопределени срокове и привидно случайни мисли, с около десетина процедури, изброени в никакъв определен ред. Тяхното ръководство липсваше такъв основните данни и как да започнете контролера нагоре, или как да го спре в случай на извънредна ситуация критична информация, че всеки новопокръстен потребител трябва да очакват да намерят в една manual.A свързани проблем е липсата на правилното използване език. Нека вземем случая, в които много от читателите не са местни англоговорящи-казвам, при търговията с даден продукт в Европа или Азия, или при писане събрание процедури за родените в чужбина работници фабрика. В такива случаи може да е необходимо да се запази език сравнително проста. Ако това е невъзможно-т.е., когато се обсъждат сложни детайли, които изискват много прецизно може да се компенсира често чрез добавяне на някои ловко подбрани, диаграми или снимки. Всяка подход може да бъде полезно при вземането на сложни малко по-лесно да absorb.4. Тъй като не е подходящо graphicIt на безспорно clichÃÆ'Ã, В ©, но е истина все пак-снимките се боя хиляда думи. По същия начин, наръчник, който прави разумното използване на изображения и диаграми, ще бъде много по-лесно да се разбере от този, който е съставен изцяло от текста descriptions.Some считат, че това се детински и ненужни. Не ми, и ми Опитът показва, че по-голямата част от потребителите ценят като тези визуални ръководства. Не забравяйте, без значение колко сложни са вашите читатели, те са все още на човека. Дори интелигентно, в противен случай внимателно читателят може да случайно пропуснете някои важни детайли, особено когато се натисне за time.5. Не е стремеж към интересни excellenceIt, за да видите как програмисти и инженери могат да се стремим към съвършенство в много аспекти от тяхната работа, но вземат точно обратния подход, когато става въпрос за документация. "На кой му пука за текста все пак?" Чувал съм много инженери се каже. "Ние не пишат поезия или сценарии тук. Важното е, че документация трябва да бъдат технически точни. "Това е ужасено недалновидна гледка. Технически точност е наистина важно, но това са презентации и стил. Малко инженери да се вслуша в работа кандидат, който се появява в една хавлия и чехли, или адвокат съдебни спорове, който говори като долината момиче и още по някакъв начин, същите тези инженери очакват своите колеги техничари (или по-лошо, един клиент!) да бъхтя чрез страниците на криволичещ, лошо фрази текст. Дори въпроси като основни за правопис, граматика и редакция често се третират просто като досада-дребен детайли, които заслужават нищо повече от един бегъл поглед. (За моя облекчение, не съм срещат такива нагласи на мястото ми на работа. Бързам да кажа това, да не би някой мисля, че съм се оплакват хората, които работят с тях! Не, аз открих, че всички ние оценяват стойността на върхови постижения, за което съм винаги благодарен. Но аз отделям.) Запомнете: Когато пишете за своите колеги техничари, трябва да се има предвид, че те често трябва да поеме обемно количество информация в оскъдно количество време. Кога писмено за миряни, трябва да се направи текста, нежно и лесно за възприемане, възможно, за да не стане губи в океана на geekspeak. Така или иначе, пускането малко повече усилия в областта на елегантност и стил може да направи един свят на difference.I няма да отидат в подробности за това какво представлява добро писане техника, тъй като това е извън обхвата на този текст. Достатъчно е да се каже, че един добър програмист или инженер трябва да сте сигурни, че творчеството му е разбираема и добре организирани, както и че тече гладко от една тема, за да another.I ще бъдат развълнувани за вярване, ако никога не видях друг размъкнат употреба, или ако никога не съм чул друга история дружества срутване поради несъществуващи документация. Безнадежден фантазия? Може би. Все пак, аз се надявам, че някои техничари изложени там ще прочетете това съобщение, и че те ще вземат да heart.About на AuthorV. Бербатов Веласко има докторска степен по електронно инженерство и е упражняване на своята търговска продължение на почти едно десетилетие. През това време той многократно е открил значението на доброто техническо писане, и клопки, които могат да възникнат от игнориране си value.Dr. Веласко в момента работи като старши софтуерен инженер от електрическо и за клетъчна технология Limited (http://www.immunospot.com, http://www.elispot-analyzers.de), една биотехнологична компания в Кливланд,
Член Източник: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
уебмастъра Вземи Html кодекс
Добави тази статия на вашия сайт сега!
уебмастъра Подайте членове
Не е необходима регистрация! Попълнете формата и статията ви е в Messaggiamo.Com директория!
