СР_1_эксплуатационная_документация_20_слайдов

1.

Самостоятельная работа №1
• Эксплуатационная документация ПО
• Порядок разработки, хранения и требования

2.

Что такое эксплуатационная документация
• Эксплуатационная документация (ЭД) — документы, которые помогают пользователю правильно
установить, запустить, использовать и обслуживать программное обеспечение.
• Она сопровождает ПО на этапе эксплуатации и помогает выполнять операции без ошибок.

3.

Зачем нужна ЭД
• объясняет порядок работы с программой;
• помогает установить и настроить ПО;
• описывает функции и ограничения;
• снижает количество ошибок пользователей;
• обеспечивает единый порядок эксплуатации.

4.

Основные виды ЭД
• руководство пользователя (оператора);
• инструкция по установке;
• инструкция по эксплуатации;
• руководство по техническому обслуживанию;
• описание применения и другие сопроводительные документы.

5.

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

6.

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

7.

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

8.

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

9.

Структура ЭД
• титульная часть и сведения о документе;
• назначение и область применения;
• требования к системе;
• порядок установки и настройки;
• порядок работы;
• описание возможных ошибок и способов их устранения.

10.

Порядок разработки ЭД
1. Определяется назначение документа и его пользователь.
2. Собираются сведения о программном продукте.
3. Определяется структура документа.
4. Готовится текст и иллюстрации.
5. Выполняется проверка и редактирование.
6. Документ утверждается и передается вместе с ПО.

11.

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

12.

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

13.

Требования к актуальности
• ЭД необходимо обновлять при существенных изменениях ПО.
• Изменения в интерфейсе, установке или функциях должны отражаться в документации.
• Старая версия документа не должна использоваться вместо актуальной.

14.

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

15.

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

16.

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

17.

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

18.

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

19.

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