Виды технической документации: проектная, рабочая, эксплуатационная

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

Виды технической документации: проектная, рабочая, эксплуатационная
Содержание
  1. Что такое техническая документация
  2. Основные виды технической документации
  3. Проектная документация
  4. Рабочая документация
  5. Эксплуатационная документация
  6. Организационные и приемочные документы
  7. Состав документации по стадиям
  8. Требования к технической документации
  9. Как подобрать нужные документы под проект
  10. Типичные ошибки при подготовке комплекта
  11. Частые вопросы

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

Техническая документация объединяет все материалы, нужные для того, чтобы создать продукт и работать с ним. Это текст, чертежи, схемы, таблицы и данные. Совокупность документов, относящихся к одному изделию или системе, называют комплектом.

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

Состав и обозначения документов зависят от выбранной системы стандартов. В программных проектах это ЕСПД, в автоматизированных системах - комплекс ГОСТ 34, в конструкторских - ЕСКД. Сравнение систем собрано в статье о том, чем отличаются ЕСПД и ЕСКД.

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

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

Три основных вида технической документации: проектная, рабочая и эксплуатационная, с примерами документов.
Три основных вида технической документации: проектная, рабочая и эксплуатационная, с примерами документов.
ВидДля чегоПримеры документовКто читает
ИсходнаяЗакрепляет цели и требованияТехническое задание, бизнес-требованияЗаказчик, руководитель проекта
ПроектнаяОписывает решения до начала производства или разработкиЭскизный и технический проект, пояснительные запискиЗаказчик, архитекторы, эксперты
РабочаяСодержит данные для изготовления и настройкиЧертежи, спецификации, тексты программ, схемыИсполнители, монтажники, программисты
ЭксплуатационнаяОбъясняет, как использовать и обслуживатьРуководства, паспорт, формуляр, описание примененияПользователи, администраторы
Испытательная и приемочнаяПодтверждает соответствие требованиямПрограмма и методика испытаний, протоколы, актыКомиссия, заказчик

Проектная документация

Проектная документация отвечает на вопрос "что мы построим и как оно будет устроено". Она создается до начала основных работ и позволяет согласовать решения без затрат на производство. Заказчик и эксперты видят структуру, состав, связи и ограничения и могут потребовать изменений.

В стандартах на создание автоматизированных систем проектные материалы делятся на эскизный и технический проект. Эскизный проект показывает общие решения, технический проект детализирует их до уровня, достаточного для разработки рабочих документов. Подробное сравнение собрано в статье об эскизном и техническом проекте.

Какие стадии выделяют в современных стандартах, объясняет материал о ГОСТ Р 59793-2021. В нем состав стадий пересмотрен по сравнению с ГОСТ 34.601-90.

Рабочая документация

Рабочая документация отвечает на вопрос "по чему это делать". Это документы, по которым изделие изготавливают, систему настраивают, а программу пишут и собирают. В отличие от проектной, она обязательна для исполнителей и должна быть однозначной.

  • Для изделий: чертежи деталей, сборочные чертежи, спецификации, схемы.
  • Для программ: текст программы, спецификация, описание структуры и алгоритмов.
  • Для автоматизированных систем: схемы подключений, планы размещения оборудования, перечни входных и выходных данных, описания информационного обеспечения.

Разница с проектной документацией видна в степени детализации. Проект можно читать как описание замысла, а рабочие документы читают как инструкцию: по ним нужно что-то сделать, и допусков на толкование почти нет. Образцы документов для систем можно посмотреть в разделе шаблонов документов по ГОСТ 34.

Эксплуатационная документация

Эксплуатационные документы предназначены для тех, кто будет использовать и обслуживать продукт. Это руководства, паспорта, формуляры, описания и инструкции. Они передаются заказчику вместе с результатом работ и входят в комплект поставки.

Для программ их состав определяют стандарты ЕСПД: руководство оператора, руководство системного программиста, описание применения, формуляр. Для изделий применяется ГОСТ 2.601. Подробный разбор видов и состава вынесен в отдельную статью об эксплуатационной документации.

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

Организационные и приемочные документы

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

  • Программа и методика испытаний. Описывает проверки, критерии и порядок. О ее составлении рассказано в материале про программу и методику испытаний.
  • Протоколы испытаний. Фиксируют фактические результаты проверок.
  • Акты приемки: промежуточный, в опытную и в промышленную эксплуатацию.
  • Ведомости: эксплуатационных документов, покупных изделий, держателей подлинников.
  • Журналы: опытной эксплуатации, изменений, замечаний.

Состав документации по стадиям

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

Автоматическую подсказку по составу для автоматизированной системы дает инструмент на странице состав документации АС по стадиям. Ниже он вставлен в статью: выберите стадию и посмотрите, какие документы по ней предусмотрены в ГОСТ 34.201.

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

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

Какими бы ни были виды документов, к ним предъявляются общие требования. Именно по ним проверяют комплект при согласовании и приемке.

  • Полнота. В комплекте есть все документы, предусмотренные стандартом, договором или планом документирования.
  • Согласованность. Названия, термины, числа и обозначения совпадают во всех документах.
  • Однозначность. Фраза не допускает двух толкований. Для этого помогает единый глоссарий, пример которого описан в статье о глоссарии терминов.
  • Актуальность. Документ соответствует текущей версии продукта. Изменения оформляются с номером редакции и датой.
  • Проверяемость. Требования сформулированы так, чтобы их можно было проверить испытаниями или осмотром.
  • Оформление. Единые поля, шрифты, нумерация, титульные листы, листы утверждения и основные надписи, как описано в материале про оформление текстовых документов по ГОСТ 2.105.
Если в договоре сказано "документация по ГОСТ", уточните, какие именно стандарты и редакции. В противном случае стороны могут понимать формулировку по-разному, и спор возникнет при приемке.

Как подобрать нужные документы под проект

Полный набор из десятков документов нужен не всегда. Объем зависит от размера, сложности системы и требований заказчика. Чтобы не писать лишнего и не пропустить обязательное, пройдите по шагам.

  1. Определите систему стандартов, действующую в проекте: ЕСПД, ГОСТ 34, ЕСКД или смешанный вариант.
  2. Выпишите документы, которые обязательны по договору и ТЗ.
  3. Добавьте документы, которые нужны вам для работы: схемы, перечни, инструкции.
  4. Для каждого документа назначьте автора, проверяющего и срок.
  5. Свяжите документы по обозначениям и зафиксируйте перечень в ведомости.
  6. На каждой стадии сверяйте список с фактическим состоянием и обновляйте его.

Небольшие проекты чаще ограничиваются техническим заданием, руководством пользователя и актом. Крупные системы дополняют их проектными документами, ведомостями и программой испытаний. Отправной точкой всегда остается техническое задание: в нем сформулированы требования, на которые опираются все остальные документы.

Типичные ошибки при подготовке комплекта

  • Документы создаются в конце проекта, когда решения уже забыты, и описывают то, что хотелось бы, а не то, что построено.
  • Один и тот же документ существует в нескольких версиях, и непонятно, какая действует.
  • Комплект составлен без ведомости, и пропавшие документы обнаруживаются только при приемке.
  • Эксплуатационные документы написаны на языке разработчика, а не пользователя.
  • Не учтены требования стандартов к обозначениям и основным надписям.
  • Изменения вносятся в код и конфигурацию, но не отражаются в документации.

Частые вопросы

Какие виды технической документации бывают?

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

Чем проектная документация отличается от рабочей?

Проектная описывает замысел и решения до начала работ, ее читают заказчик и эксперты. Рабочая содержит данные, по которым изделие изготавливают, а систему настраивают, и ее используют исполнители.

Что входит в состав технической документации?

Зависит от проекта и стандартов. Обычно это техническое задание, проектные документы, рабочие схемы и спецификации, эксплуатационные руководства, программа и методика испытаний, акты и ведомости.

Какие требования предъявляют к технической документации?

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

Где посмотреть состав документации автоматизированной системы?

В ГОСТ 34.201-89 и в новых стандартах на стадии создания АС. Для быстрой справки используйте инструмент на сайте: он показывает документы по стадиям.

Нужно ли делать полный комплект документов для небольшого проекта?

Нет. Перечень определяется договором и ТЗ. Для небольших проектов часто хватает ТЗ, руководства пользователя и акта приемки, но состав нужно согласовать с заказчиком заранее.

Читайте также