Пять ошибок, которые делают компании в связи с технической документацией
Я видел это снова и снова. Один из наиболее распространенных недостатков, которые я видел в инженерной компании-действительно, почти универсальное вина является отсутствие надлежащей технической документации. Кто-то может смеяться от этого как незначительная деталь, однако, последствия зачастую серьезные. Весь будущем компания может быть сделано или потеряли на основе объема внимания, которые они выплачивают issue.Over этого года, я выделил пять проблем, что я установлено, что особенно часто, когда дело доходит до написания технической документации. Я хотел бы поделиться этими мыслями с вами, в надежде помешать другим падают же paths.1. Не имея любой пользователь manualsDon't смеяться. Это может показаться довольно основная ошибка, абсурдным, даже, но это удивительно. Мне доводилось сталкиваться с многими компаниями, которые не обеспечивают руководства пользователя на свою продукцию, или чьи пособия skeletally тонкий или лет устарел. В самом деле, я считают, что около половины малых предприятий инженерно что я столкнулся, попадают в эту категорию. (Конечно, редко встречаются проблемы при покупке Off-The-программных полке или в бытовой электронике. Среди инженеров, хотя, это удручающе знакома история). Помню, как один инженер сказал мне, почему его компания не представила каких-либо руководств пользователя с их продуктами. В шепотом, он сказал: "Это потому, что мы не будем делать деньги в письменном виде пособий. Это не делания денег предприятию, так что наше руководство не хотите тратить время на это. Раздражало выражение пополз в его лицом, то он наклонился и сказал: "Мы потеряли много клиентов, потому что мы не достойны документации. обсуждения о том, мелочный, фунт-глупо!" Это не только клиенты, которые страдают, когда пособия недостаточны или отсутствуют. А сами работники? Что происходит, когда приходит новое инженером на борту, и быстро учиться? Или то, что происходит, когда существующие инженерам необходимо ознакомить себя более с незнакомыми аспектах своей линии продукции? Документация пользователя, если ее правильно написал, может стать мягким и эффективным способом привлечения до скорости. Без этого они будут вынуждены полагаться в большей степени на других инженеров, чтобы воспитывать их, тем самым теряя времени всех заинтересованных сторон. Недель, если не месяцы, а ценные кадры могут быть упущены в этом fashion.2. Не имея надлежащего внутреннего documentationIt's не только в пользовательской документации, что компании не отвечают на. Внутренняя документация зачастую является жертвой, а, как компании пытаются найти выпуска продукта. В спешке для появления продуктов на рынке, компании Пусть часто их внутренней проектной документации по осени безнадежно wayside.It не поможет, что программисты и инженеры за пресловутого тусклым навыки общения, и что документация является задачей, которая они редко пользуются. Мне доводилось сталкиваться с многими компаниями программного обеспечения, например, конструкции которых программное обеспечение было неразрешимых беспорядок в связи с их отсутствием архитектурных документах, интерфейс описаний и комментариев в-код. К сожалению, я видел аналогичными проблемами, когда речь идет о механических конструкций, электронных конструкций, изготовление процедур? Ваше имя Е. осведомлены 'говорил с инженерами, чьи компании имеют либо ушел под землей, или уже балансируют на грани. Почти всегда, отсутствие надлежащей документации была важным фактором в таких situations.I всегда говорят мои начальники и сотрудники, "Я хочу, чтобы убедиться, что моя работа чертовски хорошо документирована. Если бы я Написать в компанию, или если я умру в автомобильной катастрофе, потому что я хочу, чтобы убедиться, что эта компания может марте без меня. "Это должно стать одной из главных причин за поддержание тщательной документации, чтобы убедиться, что Компании не будут искалечены любого человека absence.Unfortunately, многие сотрудники принимают противоположную позицию. Они намеренно скупиться на документации, думая, что это позволит обеспечить им какую-то работу и безопасность Иногда это работает. Однако, умный работодатель знает, что инженер, документы и стоит гораздо больше, чем другой инженер, который держит свои карты, близко к его жилета. Последнее может иметь решающее значение в краткосрочной перспективе, но в конечном счете, он долгосрочных liability.3. AudienceThis Забыв одна проблема часто возникает при разработке пользовательской документации. Программисты и инженеры часто забывают, что их руководством будут читать люди, которые не знакомы с их продуктов, или которые не имеют одинаковые технические навыки. Я помню одну компанию, в частности, компания-машина контроллера на Западном берегу. Их "Руководство пользователя" была попал сумбура сокращений, неопределенные условия и, казалось бы случайных мыслей, причем около десятка процедур, перечисленных в частности, нет порядка. Их пользовательской документации не хватало таких основные сведения о том, как начать контроллера до, или Как остановить его в случае возникновения чрезвычайной ситуации критически важные детали, которые любой пользователь неофиту следует ожидать найти в manual.A связанной с этим проблемой является отсутствие надлежащего использования языка. Рассмотрим случай, в котором Многие из читателей, не являются носителями английского языка, скажем, когда маркетинг продукта в Европе или Азии, или при написании процедуры Ассамблеи для иностранного происхождения заводских рабочих. В таких случаях, это может быть необходимо для поддержания язык довольно простой. Если это не возможно, скажем, при обсуждении сложных деталей, которые требуют большей точности одного зачастую могут компенсировать, добавив некоторые удачно подобранный графиков, диаграмм или фотографий. Любой из двух подход может быть полезна при принятии сложных текстов немного легче absorb.4. Не имея надлежащей graphicIt's clichÃÆ'à бесспорно,  ©, но, тем не менее истинно-рисунок, краска тысяч слов. Аналогичным образом, Руководство делает разумное использование изображения и диаграммы, будет гораздо легче понять, чем тот, который полностью состоит из текста descriptions.Some считаем, что это детское и ненужным. Не знаю, и мои Опыт показал, что большинство пользователей ценят Имея эти визуальные гидов. Помните, как ни сложные ваши читатели, они все равно человек. Даже умный, иначе Внимательный читатель может случайное пропустить некоторые важные подробности, особенно при нажатии time.5. Не стремятся к excellenceIt интересно посмотреть, как программисты и инженеры могут стремиться к совершенству во многих аспектах их работы, но принять прямо противоположный подход, когда речь идет о документации. "Кто заботится о формулировка-то?" Я слышал много инженеров сказать. "Мы не пишем стихи, сценарии здесь. Важно то, что Документация должна быть технически точными. "Это ужасно близорукий взгляд. технической точности, действительно важны, но столь же важны представления и стиля. Немного инженеры хотели слушать работу заявитель, проявляется в халат и тапочки, или судебного адвоката, который говорит, как долина девушку и все-таки каким-то образом эти же инженеры ожидают, что их сотрудник технари (или того хуже, клиент!) к утомительной перелистывать страницы извилистая, плохо сформулирован текст. Даже в качестве основных вопросов, как орфографии, грамматики и корректура часто рассматриваются лишь как раздражающие-пустячной детали, которые ничего не стоят больше, чем беглый взгляд. (К моему облегчению, я не сталкивался с таким отношением на моем месте работы. Я спешу сказать это, чтобы любой думаете, что я жаловался, что люди с которыми я работаю! Нет, я обнаружил, что все мы ценим передового опыта, за что я всегда благодарны. Но я отвлекся.) Помните: При написании к ближнему технари, следует иметь в виду, что они часто должны поглощать объемными массивами информации на скудное количество времени. Когда Сделать мир difference.I не буду вдаваться в подробности о том, что представляет собой хороший Дать технику, так как это выходило бы за рамки этого текста. Достаточно сказать, что хороший программист или инженер должен удостовериться, что Его сочинения читаются и хорошо организованы, и что она течет плавно от одной темы к another.I будут рады за веру, если я никогда не видел другого небрежной эксплуатации, или если я никогда не слышала историю о другом компании сокращаются в результате на несуществующие документы. Безнадежная фантазия? Может быть. Тем не менее, я надеюсь, что некоторые технари там будете читать это сообщение, и что они возьмут его heart.About AuthorV. Berba Веласко Имеет степень кандидата наук в области электротехники и была орудуя торговли на протяжении почти десятилетия. За это время он неоднократно обнаружил важность хорошей технической документации, а также ошибки, которые могут возникнуть из игнорируя его value.Dr. Веласко в настоящее время работает в качестве старшего электрических и программному обеспечению для сотовых Technology 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 каталог!
