Эксплуатационная документация
Одним из самых распространенных видов технической документации является эксплуатационная документация. Для чего предназначен данный тип документации и каким требованиям должен удовлетворять?
эксплуатационная документация
документы, перечень, ведение, комплект
Что такое эксплуатационная документация?
Эксплуатационная документация – это вид технической документации, описывающий порядок установки, настройки и использования разработанного программного обеспечения (автоматизированной системы).
Как правило, документы данного вида являются составляют либо дополнение к "ядру" комплекта технической документации (проектной документации), либо полностью независимы и автономны, а в некоторых случаях являются единственной частью документации на программный продукт. Именно эксплуатационную документацию мы чаще всего подразумеваем, когда говорим о программной документации в целом.
Какие основные документы входят в состав эксплуатационной документации?
– руководство пользователя;
– руководство администратора;
– руководство программиста;
– и т.д.
Стоит отметить, что все эти документы – это лишь основной перечень в соответствии с ролями пользователей (программист, администратор, обычный пользователь). Однако в комплекте эксплуатационной документации помимо Руководства пользователя очень часто встречается Краткое руководство пользователя, Руководство по быстрому старту и т.д. – все эти документы по сути также являются Руководством пользователя, но представлены в несколько иных вариациях.
В соответствии с какими отечественными стандартами разрабатывается эксплуатационная документация?
– ЕСКД, Единая система конструкторской документации (ГОСТ 2);
– ЕСПД, Единая система программной документации (ГОСТ 19);
– КСАС, Комплекс стандартов на автоматизированные системы (ГОСТ 34).
Каждая из вышеперечисленных серий ГОСТ предъявляет свои требования к составу, порядку разработки и ведения комплектов эксплуатационной документации, а также к содержанию и оформлению отдельных документов комплекта.
В соответствии с какими зарубежными стандартами разрабатывается эксплуатационная документация?
Данный вид документации в плоскости зарубежных стандартов разработки документации соответствует следующим видам:
– End user, руководства для пользователей, администраторов и обслуживающего персонала (аналог Руководство пользователя, Руководство администратора);
– Technical, описание кода, алгоритмов и интерфейсов (аналог Руководство программиста, Справочник разработчика).
В отличие от ГОСТов, за рубежом изначально несколько иной подход к стандартам документирования.
Где найти примеры эксплуатационной документации?
Вы можете изучить требования к данному виду документации, полистав соответствующие стандарты в нашем разделе Библиотека, а также ознакомиться с фрагментами подготовленной нами эксплуатационной документации в разделе Проекты.
Сколько стоит разработка эксплуатационной документации?
Стоимость разработки документации данного вида зависит от множества факторов. Однако вы можете ознакомиться с примерным диапазоном цен в соответствующем разделе и оценить приблизительную стоимость подготовки и оформления вашей эксплуатационной документации.
Как заказать разработку эксплуатационной документации?
Просто нажмите кнопку снизу – вы сможете сформировать требуемый комплект эксплуатационной документации и сразу увидеть приблизительные затраты, после чего направить его нам на согласование, а мы уже уточним все детали. Это быстро и бесплатно.