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

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

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

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

патенты
характеристики изделия или компонентов/материалов
листы данных изделия или компонентов/материалов
методы испытаний
производственные стандарты
системные требования
системная архитектура
документация и данные по проектированию системы, включая те, которые необходимы для разработки, тестирования, производства, эксплуатации и обслуживания системы.

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

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

Дисциплина

ИСО 15787 ^[2]
ИСО 3098 ^[3]
ИСО 10209 ^[4]
ИСО 2162 ^[5]
ИСО 5457 ^[6]
ИСО 6433 ^[7]

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

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

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

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

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

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

См. также

Цитаты

^ «01.110: Техническая документация на продукцию» . Международная организация по стандартизации . Проверено 10 июня 2009 г.
^ «ISO 15787:2001 Техническая документация на продукцию. Термообработанные детали из черных металлов. Представление и указания» . Международная организация по стандартизации . Проверено 10 июня 2009 г.
^ «ISO 3098-0:1997 Техническая документация на продукцию. Буквы. Часть 0. Общие требования» . Международная организация по стандартизации . Проверено 10 июня 2009 г.
^ «ISO 10209-1:1992 Техническая документация на продукцию. Словарь. Часть 1. Термины, относящиеся к техническим чертежам: общие сведения и типы чертежей» . Международная организация по стандартизации . Проверено 10 июня 2009 г.
^ «ISO 2162-1:1993 Техническая документация на продукцию. Пружины. Часть 1. Упрощенное представление» . Международная организация по стандартизации . Проверено 10 июня 2009 г.
^ «ISO 5457:1999 Техническая документация на продукцию. Размеры и расположение чертежных листов» . Международная организация по стандартизации . Проверено 10 июня 2009 г.
^ ISO6433 Техническая документация на продукцию. Ссылки на детали , BSI British Standards, doi : 10.3403/30203812 , получено 16 декабря 2020 г.
^ «Неполный список комплектов документации Diátaxis» . Проверено 10 апреля 2021 г.
^ «Схема форм документации Diátaxis» . Проверено 10 апреля 2021 г.
^ «Термины и определения модульной документации RedHat» . Проверено 11 апреля 2021 г.

[tpd-1] «01.110: Техническая документация на продукцию» . Международная организация по стандартизации . Проверено 10 июня 2009 г.

[tpdh-2] «ISO 15787:2001 Техническая документация на продукцию. Термообработанные детали из черных металлов. Представление и указания» . Международная организация по стандартизации . Проверено 10 июня 2009 г.

[tpdl-3] «ISO 3098-0:1997 Техническая документация на продукцию. Буквы. Часть 0. Общие требования» . Международная организация по стандартизации . Проверено 10 июня 2009 г.

[tpdv-4] «ISO 10209-1:1992 Техническая документация на продукцию. Словарь. Часть 1. Термины, относящиеся к техническим чертежам: общие сведения и типы чертежей» . Международная организация по стандартизации . Проверено 10 июня 2009 г.

[tpds-5] «ISO 2162-1:1993 Техническая документация на продукцию. Пружины. Часть 1. Упрощенное представление» . Международная организация по стандартизации . Проверено 10 июня 2009 г.

[tpds2-6] «ISO 5457:1999 Техническая документация на продукцию. Размеры и расположение чертежных листов» . Международная организация по стандартизации . Проверено 10 июня 2009 г.

[7] ISO6433 Техническая документация на продукцию. Ссылки на детали , BSI British Standards, doi : 10.3403/30203812 , получено 16 декабря 2020 г.

[diataxisadoption-8] «Неполный список комплектов документации Diátaxis» . Проверено 10 апреля 2021 г.

[diataxisforms-9] «Схема форм документации Diátaxis» . Проверено 10 апреля 2021 г.

[redhatmodules-10] «Термины и определения модульной документации RedHat» . Проверено 11 апреля 2021 г.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]