Техническая документация - Technical documentation

В машиностроении, техническая документация относится к любому типу документация который описывает обращение, функциональность и архитектуру технического продукта или продукта под разработка или используйте.[1][2][3] Предполагаемый получатель технической документации по продукту - оба (опытные) конечный пользователь а также администратор / сервис или поддержание техник. В отличие от простой «поваренной книги» руководство, техническая документация направлена ​​на предоставление пользователю достаточной информации, чтобы понять внутренние и внешние зависимости продукта.

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

Документация, сопровождающая технологию, часто является единственным средством, с помощью которого пользователь может полностью понять указанную технологию; Тем не менее, разработчики программного обеспечения часто считают техническую документацию «неизбежным злом». Следовательно, жанр пострадал от того, что некоторые отраслевые эксперты сетуют на недостаток внимания и точности.[4] Написание и сопровождение документации требует многих технических и нетехнических навыков, и эта работа часто не приносит такого удовольствия или вознаграждается, как написание и сопровождение кода.[5]

Формы

Формы технической документации могут включать:

В течение жизненного цикла системы большое количество типов документов будет играть важную роль:

и их различные промежуточные или промежуточные документы.

Стандартизация форм

Традиционно в большинстве форм технической документации отсутствуют признанные стандарты, но сейчас ситуация меняется.[4] Так далеко, ISO опубликовал серию стандарты относящиеся к технической документации продукта, и они покрываются ICS 01.110.[6] Те, на которые не распространяется ICS 01.110, перечислены в подразделе ниже.

В зависимости от дисциплины

Правила ЕС

Техническая документация также необходима для медицинских изделий, следующих Регулирование медицинского оборудования ЕС.Приложения II и III регламента описывают содержание технической документации на медицинский прибор Это включает, например, информация о маркировке, дизайне, управлении рисками и клинической оценке устройства.

Форматы исходных данных

Смотрите также

Цитаты

  1. ^ Что такое «техническая документация»? на Transcom.de. Доступ 25 февраля 2013 г.
  2. ^ Что такое техническая документация? В архиве 2013-04-18 в Archive.today в Tetras Translations. Доступ 25 февраля 2013 г.
  3. ^ Документирование новой системы в IGCSE ICT. Доступ 25 февраля 2013 г.
  4. ^ а б Сцена документации пользователя John Mobbs. Институт научно-технических коммуникаторов, Понедельник, 23 июля 2012 г.
  5. ^ Гейгер, Р. Стюарт; Вароко, Нелле; Мазель-Кабасс, Шарлотта; Холдграф, Крис (29.05.2018). «Типы, роли и методы документации в библиотеках программного обеспечения с открытым исходным кодом для анализа данных». Совместная работа с компьютерной поддержкой (CSCW). 27 (3–6): 767–802. arXiv:1805.12398. Дои:10.1007 / s10606-018-9333-1. ISSN  0925-9724. S2CID  44141371.
  6. ^ «01.110: Техническая документация на продукцию». Международная организация по стандартизации. Получено 10 июн 2009.
  7. ^ «ISO 15787: 2001 Техническая документация на продукцию. Термообработанные детали из черных металлов. Представление и указания». Международная организация по стандартизации. Получено 10 июн 2009.
  8. ^ «ISO 3098-0: 1997 Техническая документация на продукцию - Надписи - Часть 0: Общие требования». Международная организация по стандартизации. Получено 10 июн 2009.
  9. ^ «ISO 10209-1: 1992 Техническая документация на продукцию - Словарь - Часть 1: Термины, относящиеся к техническим чертежам: общие и типы чертежей». Международная организация по стандартизации. Получено 10 июн 2009.
  10. ^ «ISO 2162-1: 1993 Техническая документация на продукцию - Пружины - Часть 1: Упрощенное изображение». Международная организация по стандартизации. Получено 10 июн 2009.
  11. ^ «ISO 5457: 1999 Техническая документация на продукцию - Размеры и расположение чертежей». Международная организация по стандартизации. Получено 10 июн 2009.