Руководство по техническому обслуживанию
Руководство по техническому обслуживанию относится к эксплуатационной документации, которое содержит описание функций, общие указания к применению и обслуживанию программы.
Главная задача документа — обеспечение персонала информацией о правильном применении и техническом обслуживании программы. Руководство по техническому обслуживанию разрабатывается для пользователей программы, а также специалистов, которые занимаются обслуживанием программного обеспечения. В документе отображаются сведения для использования диагностических, тестовых и других типов программ, которые применяются при техническом обслуживании. Документ разрабатывается в соответствии со стандартами ГОСТ 19.105-78 (общие требования к программным документам) и ГОСТ 19.508-79 (требования к оформлению руководства по техническому обслуживанию).
Руководство по техническому обслуживанию является частью общей документации на программное обеспечение и сопутствующее оборудование, а также входит в состав руководства по эксплуатации.
Структура документа
Обязательные разделы руководства по техническому обслуживанию:
1. Аннотация.
- Характеристика документа, краткое описание его назначения, содержания, вида и прочих особенностей.
2. Содержание.
- Указываются заголовки документа с соответствующими номерами страниц.
3. Введение.
- Определяется цель руководства, перечень эксплуатационной документации и общие сведения (п. 2.1 ГОСТ 19.508-79).
4. Общие указания.
- В разделе отображаются указания по организации, порядок и методика проведения технического обслуживания (п. 2.2 ГОСТ 19.508-79).
5. Требования к техническим средствам.
- Определяется полный состав технических средств, которые необходимы для работы (п. 2.3 ГОСТ 19.508-79).
6. Описание функций (п. 2.4 ГОСТ 19.508-79).
- Максимальный список тех. средств;
- Описание функционирования оборудования и технических средств, а также определение способа обработки ошибок;
- Входные и выходные данные, которые применяются при техническом обслуживании;
- Определяются возможные результаты работы и возможность взаимодействия оборудования с другими средствами.
В зависимости от типа оборудования могут вводиться дополнительные разделы: хранение, транспортировка, способы утилизации и т.д. Использование рисунков, схем и фотографий допускается в рамках требований соответствующих нормативов.
Даже если интерфейс администратора интуитивно понятен, однако руководство по техническому обслуживанию остается обязательным документом. В особенности это касается программ и оборудования, которое обслуживается несколькими людьми. Для каждой группы следует прописывать уровень доступа, выполняемые функции, требования к обслуживанию и т.д.