Техническая документация — это общий термин для классов информации , созданной для описания (на техническом языке ) использования, функциональности или архитектуры продукта, системы или услуги.
К классам технической документации могут относиться:
Исторически сложилось так, что большинство классов технической документации не имели универсального соответствия (стандартов) по формату, содержанию и структуре. Для решения этой проблемы разрабатываются стандарты с помощью таких организаций, как Международная организация по стандартизации (ISO), которая опубликовала стандарты , касающиеся правил подготовки руководств пользователя, руководств, спецификаций продукции и т. д. для технической документации на продукцию. Эти стандарты описаны в ICS 01.110. [1] Техническая документация по продукту, не подпадающая под действие ICS 01.110, приведена в подразделе ниже.
Для медицинских устройств также требуется техническая документация в соответствии с Регламентом ЕС о медицинских устройствах . Приложение II «Техническая документация» и Приложение III «Техническая документация по послепродажному надзору» регламента описывают содержание технической документации на медицинское изделие . Сюда входит, например, информация о технических характеристиках устройства, маркировке и инструкциях, конструкции и производстве, требованиях безопасности и производительности, управлении рисками, а также валидации и верификации устройства, включая клиническую оценку; а также данные постмаркетингового наблюдения .
Некоторые системы документации касаются общих типов или форм документации, составляющих набор документации, а также (или, скорее, не) того, как документация создается, публикуется или форматируется.
Например, структура Diátaxis (которая в основном используется в области документации программного обеспечения [8] ) предполагает четыре отдельные формы документации, соответствующие четырем различным потребностям пользователя: учебные пособия , практические руководства , ссылки и объяснения . [9] Напротив, DITA утверждает пять различных «типов тем»: Задача , Концепция , Справочник , Запись в глоссарии и Устранение неполадок , в то время как модульная система документации RedHat использует три «модуля» : Концепция , Процедура и Справочник . [10]