stringtranslate.com

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

Техническая документация — это общий термин для классов информации, созданных для описания (на техническом языке ) использования, функциональности или архитектуры продукта, системы или услуги.

Классы технической документации

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

Стандартизация технической документации

Исторически большинство классов технической документации не имели универсального соответствия (стандартов) для формата, содержания и структуры. Стандарты разрабатываются для исправления этого через такие органы, как Международная организация по стандартизации (ISO), которая опубликовала стандарты, касающиеся правил подготовки руководств пользователя, инструкций, спецификаций продуктов и т. д. для технической документации продуктов. Эти стандарты охватываются ICS 01.110. [1] Техническая документация продуктов, не охватываемая ICS 01.110, перечислена в подразделе ниже.

Специфический для дисциплины

Регламент ЕС по медицинским приборам

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

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

Архитектура и типизация документации

Некоторые системы документирования касаются общих типов или форм документации, составляющих комплект документации, а также (или скорее) того, как документация создается, публикуется или форматируется.

Например, фреймворк Diátaxis (который в основном используется в области документации программного обеспечения [8] ) устанавливает четыре различные формы документации, соответствующие четырем различным потребностям пользователей: учебные пособия , практические руководства , справочные материалы и пояснения . [9] Напротив, DITA утверждает пять различных «типов тем»: Задача , Концепция , Ссылка , Запись глоссария и Устранение неполадок , в то время как система модульной документации RedHat использует три «модуля»: Концепция , Процедура и Ссылка . [10]

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

Цитаты

  1. ^ "01.110: Техническая документация по продукту". Международная организация по стандартизации . Получено 10 июня 2009 г.
  2. ^ "ISO 15787:2001 Техническая документация на продукцию. Термообработанные детали из черных металлов. Представление и указания". Международная организация по стандартизации . Получено 10 июня 2009 г.
  3. ^ "ISO 3098-0:1997 Техническая документация на продукцию -- Надписи -- Часть 0: Общие требования". Международная организация по стандартизации . Получено 10 июня 2009 г.
  4. ^ "ISO 10209-1:1992 Техническая документация на продукцию — Словарь — Часть 1: Термины, относящиеся к техническим чертежам: общие положения и типы чертежей". Международная организация по стандартизации . Получено 10 июня 2009 г.
  5. ^ "ISO 2162-1:1993 Техническая документация на продукцию -- Пружины -- Часть 1: Упрощенное представление". Международная организация по стандартизации . Получено 10 июня 2009 г.
  6. ^ "ISO 5457:1999 Техническая документация на продукцию. Размеры и расположение чертежных листов". Международная организация по стандартизации . Получено 10 июня 2009 г.
  7. ^ Техническая документация по продукции ISO6433 . Ссылки на детали, Британские стандарты BSI, doi :10.3403/30203812 , получено 16.12.2020
  8. ^ "Частичный список комплектов документации Diátaxis" . Получено 10 апреля 2021 г. .
  9. ^ "Описание форм документации Diátaxis" . Получено 10 апреля 2021 г. .
  10. ^ "Термины и определения RedHat Modular Documentation" . Получено 11 апреля 2021 г. .