Техническая документация - это общий термин для классов информации, созданных для описания (на техническом языке ) использования, функциональности или архитектуры продукта, системы или услуги.
Классы технической документации
Классы технической документации могут включать:
- патенты
- спецификации изделия или компонентов / материалов
- паспорта изделия или компонентов / материалов
- методы испытаний
- стандарты производства
- Системные Требования
- Архитектура системы
- документы и данные по проектированию системы, включая те, которые необходимы для разработки, тестирования, производства, эксплуатации и технического обслуживания системы.
Стандартизация технической документации
Исторически сложилось так, что большинству классов технической документации не хватало универсального соответствия (стандартов) формата, содержания и структуры. Стандарты разрабатываются для исправления этого положения через такие органы, как Международная организация по стандартизации (ISO), которая опубликовала стандарты, касающиеся правил подготовки руководств пользователя, руководств, спецификаций продуктов и т. Д. Для технической документации продукта. Эти стандарты охватываются ICS 01.110. [1] Техническая документация по продукту, на которую не распространяется ICS 01.110, приведена в подразделе ниже.
В зависимости от дисциплины
Правила ЕС
Техническая документация также необходима для медицинских устройств в соответствии с правилами ЕС в отношении медицинских устройств . Приложения II и III к регламенту описывают содержание технической документации на медицинское изделие . Сюда входит, например, информация о маркировке, дизайне, управлении рисками и клинической оценке устройства.
Форматы исходных данных
Архитектура документации и набор текста
Некоторые системы документации связаны с общими типами или формами документации, которые составляют набор документации, а также (или скорее) с тем, как документация создается, публикуется или форматируется.
Например, фреймворк Diátaxis (который в основном используется в области документации программного обеспечения [8] ) устанавливает четыре отдельные формы документации, соответствующие четырем различным потребностям пользователей: учебные пособия , практические руководства , справочные материалы и пояснения . [9] В отличие от этого, DITA утверждает пять различных «типов тем»: задача , концепция , справочник , запись в глоссарии и устранение неполадок , в то время как система модульной документации RedHat использует три «модуля»: концепция , процедура и справочник . [10]
Смотрите также
Цитаты
- ^ «01.110: Техническая документация по продукту» . Международная организация по стандартизации . Проверено 10 июня 2009 года .
- ^ «ISO 15787: 2001 Техническая документация на продукцию - Термообработанные детали из черных металлов. Представление и показания» . Международная организация по стандартизации . Проверено 10 июня 2009 года . CS1 maint: обескураженный параметр ( ссылка )
- ^ «ISO 3098-0: 1997 Техническая документация на продукцию - Надписи - Часть 0: Общие требования» . Международная организация по стандартизации . Проверено 10 июня 2009 года . CS1 maint: обескураженный параметр ( ссылка )
- ^ «ISO 10209-1: 1992 Техническая документация на продукцию - Словарь - Часть 1: Термины, относящиеся к техническим чертежам: общие и типы чертежей» . Международная организация по стандартизации . Проверено 10 июня 2009 года . CS1 maint: обескураженный параметр ( ссылка )
- ^ «ISO 2162-1: 1993 Техническая документация на продукцию - Пружины - Часть 1: Упрощенное изображение» . Международная организация по стандартизации . Проверено 10 июня 2009 года . CS1 maint: обескураженный параметр ( ссылка )
- ^ «ISO 5457: 1999 Техническая документация на продукцию - Размеры и расположение чертежных листов» . Международная организация по стандартизации . Проверено 10 июня 2009 года . CS1 maint: обескураженный параметр ( ссылка )
- ^ ISO6433 Техническая документация на продукцию. Ссылки на детали , Британские стандарты BSI , получено 16 декабря 2020 г.
- ^ «Неполный список комплектов документации Diátaxis» . Проверено 10 апреля 2021 года .
- ^ «Схема форм документации Diátaxis» . Проверено 10 апреля 2021 года .
- ^ «Термины и определения модульной документации RedHat» . Проверено 11 апреля 2021 года .