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

Техническая документация — набор документов, используемых при проектировании (конструировании), изготовлении и использовании объектов техники: зданий, сооружений, промышленных изделий, включая программное и аппаратное обеспечение.

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

* конструкторские документы, включая чертежи, спецификации, пояснительные записки, технические отчеты, технические условия, эксплуатационные и ремонтные документы (регламенты, руководства и т. п.) и др.;
* технологические документы, включая документы, необходимые для организации производства и ремонта изделия;
* программные документы, сопровождающие программы для электронно-вычислительных машин (программные средства).

К технической документации также могут быть отнесены техническая литература, стандарты на объекты техники, электронные технические данные, используемые не в форме документов.

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

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

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

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

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

### Специфика дисциплины[править/ править код]

* ISO 15787
* ISO 3098
* ISO 10209
* ISO 2162
* ISO 5457
* ISO 6433

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

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

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

* Архитектура типизации информации Darwin (DITA)
* DocBook
* S1000D
* Реструктурированный текст

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

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

Например, платформа Diátaxis (которая в основном используется в области документации по программному ) устанавливает четыре различные формы документации, соответствующие четырем различным потребностям пользователей: *учебные пособия*, *практические руководства*, *ссылки* и *пояснения*. В отличие от этого, DITA утверждает пять различных "типов тем":*Задача*, *концепция*, *справочник*, *запись глоссария*и *устранение неполадок*, в то время как модульная система документации RedHat использует три "модуля": *концепцию*, *процедуру* и *справочник*.

## Стандарты

* Единая система конструкторской документации (ЕСКД)
* Единая система программной документации (ЕСПД)
* Единая система технологической документации (ЕСТД)
* Единая система технологической подготовки производства (ЕСТПП)

## Примечания

1. ↑ Техническая документация: виды и процесс разработки