​Что такое «техническая документация»?

«Техническая документация» - это общий термин для документации по продукту. Люди в основном ассоциируют этот термин с документами и информацией, которые производитель передает общественности:

Инструкция пользователя

Инструкция по эксплуатации

Инструкция по обслуживанию

Руководства по установке

Руководства по программному обеспечению

Термин «техническая документация» относится к разным документам с данными о продукте и информацией, которые используются и хранятся для разных целей. «Различные цели» означают: определение и спецификацию продукта, дизайн, производство, обеспечение качества, ответственность за продукт, представление продукта; описание функций, функций и интерфейсов; предполагаемое, безопасное и правильное использование; обслуживание и ремонт технического продукта, а также его безопасная утилизация.

Это более широкое представление, в котором все документы, созданные в течение жизненного цикла продукта, рассматриваются как часть технической документации, безусловно, оправдано. В конце концов, цель состоит в том, чтобы предоставить технические ноу-хау и историю продуктов для последующих пользователей информации (будь то инженеры или операторы, патентные агенты или прокуроры, специализирующиеся на ответственности за качество продукции).

Однако для поставщиков услуг в области технической документации основное внимание уделяется документам, которые требуются после производственного процесса - продавцами, системными интеграторами, персоналом по установке, операторами, специалистами по обслуживанию, компаниями по удалению отходов и т. Д. Причины просты. :

К документам предъявляются высокие требования с точки зрения понятности и ясности (в отношении конкретной целевой группы), графического дизайна, соблюдения стандартов / директив / публичных законов, лингвистической корректности и т. Д.

Документы передаются общественности, т.е. являются частью публичной презентации производителя.

Для оформления документов, как правило, требуются относительно небольшие специфические для производителя знания и ноу-хау, особенно секреты компании. Вместо этого требуется большой опыт работы с инструментами и целевыми носителями, что особенно заметно в случае публикации в Интернете, такой как справочная система (WinHelp, HTMLHelp, JavaHelp или «просто» DHTML-Help).

Такое сочетание необходимых базовых знаний, опыта выполнения требований и специальных знаний в области документации, а также комбинации «абсолютно необходимо», если учесть вышеизложенные причины аутсорсинга, доступно от одной конкретной профессии: технический писатель / технический редактор. Эти специалисты являются посредниками между производителем / разработчиком и лицом, принимающим решения, или пользователем, либо внутри компании, либо в качестве поставщика услуг.

Кстати, в Transcom мы часто предпочитаем более общий термин «(Link intern)« техническая коммуникация », а не« техническая документация », поскольку он более точно отображает объем наших услуг.

Инструкции по сравнению с указаниями по сравнению с руководством по сравнению с руководством по сравнению с ...

Часто все еще существует путаница относительно того, следует ли что-то называть инструкциями по эксплуатации, руководством пользователя, руководством пользователя, инструкциями пользователя, руководством по эксплуатации и т. Д. Стр. Стандарты для технических редакторов и законодателей также не соответствуют их терминологии. Попробуем разобраться с лингвистической точки зрения:

«Направления» происходит от «руководить»: здесь руководителем подчиняется начальник, т. Е. Босс руководит сотрудником (или родителями своего ребенка). Следовательно, указания пользователя могут быть даны только внутри (внутри компании). Соответственно, руководство пользователя - это документ, в котором подробно описываются процедуры для конкретного рабочего места. Он учитывает конкретные требования и требования внутри компании. Это дает понять, что производитель продукта не может предоставить указания пользователя: производитель не знает о внутренних принципах компании пользователя.

«Инструкции» происходит от «инструктировать». Кто-то, способный на что-то, уже наставляет кого-то, кто хочет научиться этому. Здесь две сущности встречаются с глазу на глаз, например, производитель и пользователь. Поэтому инструкции являются документом, в котором сообщается, как применять и использовать продукт. Однако, когда вы «инструктируете», вы не сообщаете никакой теории, т. Е. Описание продукта, строго говоря, не является частью инструкций. Термин «инструкции» не зависит от издательского носителя, он не говорит вам, печатается ли он на бумаге или в Интернете

«Инструкции пользователя» или «руководство пользователя»: первое слово в каждой группе уже говорит об этом - речь идет об использовании продукта. Поскольку «руководство» обычно ассоциируется с «книгой», «руководство пользователя» - это книга, в которой описано использование. Носитель публикации указан. С другой стороны, термин «инструкции пользователя» не зависит от носителя.

Похожие статьи:

  1. ​Что такое продвижение/раскрутка сайта
  2. ​Услуги по переделке микроавтобусов
  3. Что такое стеновая панель?
  4. ​Что такое геодезия?
  5. ​Что такое куботан и как им пользоваться?