Требования к эксплуатационной документации (ЭД)

1.

Самостоятельная работа №1
Выполнил работу : Саид Малащук 21 ип

2.

Темы самостоятельной работы
1. Эксплуатационная документация: порядок и условия разработки и
хранения.
2. Требования к эксплуатационной документации (ЭД).

3.

Что такое эксплуатационная документация?
Эксплуатационная документация – это часть конструкторской
документации по ГОСТ Р 2.601-2019, содержащая сведения, необходимые
для правильной эксплуатации изделия: описание конструкции, принципа
работы, технических характеристик, а также правила использования,
обслуживания и ремонта.
В отличие от общей технической документации, которая охватывает весь
жизненный цикл изделия (проектирование, производство, контроль),
эксплуатационная документация относится исключительно к стадии
применения изделия.

4.

Нормативная база
Ключевой стандарт: ГОСТ Р 2.610-2019 — «Единая система
конструкторской документации. Правила выполнения
эксплуатационных документов».
Что он регламентирует?
виды документов (руководство по эксплуатации, паспорт,
формуляр, этикетка и др.)
структуру и содержание
оформление и маркировку предупреждений.

5.

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

6.

Основные виды ЭД
1.Внутренний ЭДО — документы между сотрудниками и отделами одной
организации.
2. Внешний ЭДО — обмен документами с другими организациями,
клиентами и партнёрами.
3. Государственный ЭДО — электронный обмен документами с
государственными органами.
4. Юридически значимый ЭДО — документы имеют юридическую силу,
обычно подтверждаются электронной подписью.
5. Безюридический ЭДО — используется для информационного обмена,
без необходимости юридического подтверждения.

7.

Условия разработки ЭД
1. Документация создаётся вместе с разработкой/сопровождением ПО
2. Содержание должно соответствовать назначению программы
3. Информация проверяется на актуальность
4. Изменения в ПО должны отражаться в документации
5. Документ должен быть доступен тем, кто его использует.

8.

Порядок разработки
1. Сбор исходных данных и требований.
2. Определение комплекта ЭД (какие документы нужны).
3. Написание разделов: безопасность, монтаж, эксплуатация, ТО, ремонт,
утилизация.
4. Выделение предупреждений и запретов (маркеры ПРЕДУПРЕЖДЕНИЕ,
ВНИМАНИЕ, ЗАПРЕЩАЕТСЯ).
5. Согласование и утверждение.

9.

Сбор исходных данных
1. Определение требований — определяются требования к системе,
пользователям и условиям эксплуатации.
2. Сбор технических данных — собираются сведения о версии ПО,
оборудовании и используемых компонентах.
3. Изучение нормативных требований — изучаются правила и стандарты,
которым должна соответствовать документация.
4. Определение состава ЭД — определяется, какие документы
необходимо разработать для данного ПО.
5. Проверка полученных данных — информация уточняется и
согласовывается перед началом разработки.

10.

Условия хранения бумажные и электронные
документы
Электронные
Бумажные
1.резервное копирование
1.сухое, тёмное помещение
2.разграничение прав доступа
2.контроль температуры и
влажности
3.хранение в папках/шкафах с
нумерацией.
3.архивирование и контроль
целостности файлов.

11.

Организация хранения в компании
1.распоряжение руководителя (кто отвечает, где хранить, как выдавать)
2.учёт и регистрация документов (журнал/база данных)
3.сроки хранения (обычно — весь срок эксплуатации изделия)
4.процедуры восстановления при утрате.
Распоряжение
Ответственный
Место хранения
Журнал учёта

12.

Руководство по эксплуатации
1. Назначение и основные возможности ПО
2. Порядок установки и запуска
3. Порядок работы с программой
4. Правила безопасной эксплуатации
5. Возможные ошибки и способы их устранения
6. Порядок обновления и тех. обслуживания

13.

Инструкция по установке
1. Системные требования — ОС, оборудование и необходимое
дополнительное ПО.
2.Подготовка — проверка совместимости, свободного места и прав
доступа.
3. Установка— последовательность действий при запуске и установке
программы.
4. Настройка — выбор основных параметров и места установки.
5. Проверка — первый запуск и проверка корректности работы.

14.

Сбор исходных данных и требований
1.Определение требований — требования к системе, пользователям и
условиям эксплуатации.
2.Сбор технических данных — сведения о версии ПО, оборудовании и
используемых компонентах.
3.Изучение нормативных требований — правила и стандарты, которым
должна соответствовать документация.
4.Определение состава ЭД — какие документы необходимо разработать
для данного ПО.
5.Проверка полученных данных — уточнение и согласование информации
перед началом разработки.

15.

Обновление документации
Обновление документации необходимо для поддержания её актуальности.
При изменении программного обеспечения информация в документации
должна быть своевременно изменена, проверена и согласована.
1.Проверка
Актуальна ли
инф?
2.Изменение
Что изменилось в
ПО?
3.Исправление
Обновление
текста документа
4.Проверка
Согласование
новой версии
5.Архив
Сохранение
старой версии

16.

Требования к содержанию
Содержание эксплуатационной документации должно быть понятным,
актуальным и соответствовать назначению программного обеспечения. В
документе должна содержаться информация, необходимая для
правильной и безопасной работы пользователя.
Соответствие
Доступность
Понятность
Актуальность
Безопасность

17.

Требования к актуальности
1. Проверка информации — сведения в документации должны
соответствовать текущему состоянию программного обеспечения.
2. Учет изменений — все изменения в ПО должны своевременно
отражаться в документации.
3. Контроль версий — необходимо отслеживать версии программного
обеспечения и соответствующие им версии документации.
4. Обновление — при изменении программы соответствующие разделы
документации должны быть пересмотрены и обновлены.
5. Доступность — пользователям должна предоставляться актуальная
версия документации.

18.

Сравнение бумажной и электронной ЭД
Бумажная
Электронная
1.Хранится в папках и шкафах
2.Требует сухого и темного
помещения
3.Необходимо контролировать
температуру и влажность
4.Документы имеют нумерацию
1.Хранится на электронных
носителях
2.Требуется резервное
копирование
3.Разграничиваются права доступа
4.Используется архивирование
5.Контролируется целостность
файлов
5.Доступ осуществляется к физ.
экземпляру

19.

Практические рекомендации
1.утвердить комплект ЭД на этапе проектирования✓
2.назначить ответственного за хранение и актуализацию✓
3.внедрить электронный архив с резервным копированием✓
4.регулярно проверять актуальность и наличие документов✓

20.

Итоги и выводы
Эксплуатационная документация необходима для правильного
использования, обслуживания и ремонта программного
обеспечения.
Разработка ЭД включает сбор исходных данных, определение
состава документов, подготовку содержания, согласование и
утверждение.
Документация должна быть актуальной, понятной, доступной
пользователю и соответствовать текущей версии ПО.
Важное значение имеет правильное хранение документов — как в
бумажном, так и в электронном виде.
При изменении программного обеспечения эксплуатационная
документация должна своевременно обновляться.