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

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

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

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

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

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

В зависимости от дисциплины

Правила ЕС

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

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

Архитектура документации и набор текста

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

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

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

Цитаты