Руководство по техническому обслуживанию
Руководство по техническому обслуживанию относится к эксплуатационной документации, которое содержит описание функций, общие указания к применению и обслуживанию программы.
Главная задача документа — обеспечение персонала информацией о правильном применении и техническом обслуживании программы. Руководство по техническому обслуживанию разрабатывается для пользователей программы, а также специалистов, которые занимаются обслуживанием программного обеспечения. В документе отображаются сведения для использования диагностических, тестовых и других типов программ, которые применяются при техническом обслуживании.
Документ разрабатывается в соответствии со стандартами ГОСТ 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).
— Максимальный список тех. средств;
— Описание функционирования оборудования и технических средств, а также определение способа обработки ошибок;
— Входные и выходные данные, которые применяются при техническом обслуживании;
— Определяются возможные результаты работы и возможность взаимодействия оборудования с другими средствами.
В зависимости от типа оборудования могут вводиться дополнительные разделы: хранение, транспортировка, способы утилизации и т.д. Использование рисунков, схем и фотографий допускается в рамках требований соответствующих нормативов.
Даже если интерфейс администратора интуитивно понятен, однако руководство по техническому обслуживанию остается обязательным документом. В особенности это касается программ и оборудования, которое обслуживается несколькими людьми. Для каждой группы следует прописывать уровень доступа, выполняемые функции, требования к обслуживанию и т.д.
Оформите заявку и задавайте все интересующие вас вопросы по телефону +7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.
УДК |
Группа |
Г О С У Д А Р
С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю
З А С С Р
Единая |
ГОСТ 19.508-79 |
РУКОВОДСТВО |
|
United system for |
Постановлением Государственного
комитета СССР по стандартам от 11 декабря
1979 г. № 4753 срок введения установлен
с 01.01. 1981 г.
Настоящий стандарт устанавливает
требования к содержанию и оформлению
программного документа «Руководство
по техническому обслуживанию»,
определённого ГОСТ 19.101-77, и распространяется
на тестовые и диагностические программы,
используемые при обслуживаниии
технических средств.
1. ОБЩИЕ
ПОЛОЖЕНИЯ
1. Структура и оформление документа
устанавливаются в соответствии с ГОСТ
19.105-78.
Составление информационной части
(аннотация и содержание) является
обязательным.
1.2. Руководство по техническому
обслуживанию должно содержать следующие
разделы:
-
введение;
-
общие указания;
-
требования к техническим средствам;
-
описание функций;
В зависимости от особенностей документа
допускается вводить дополнительные
разделы.
2. СОДЕРЖАНИЕ
РАЗДЕЛОВ
2.1. В разделе «Введение» указывают
назначение руководства, перечень
эксплуатационных документов, которыми
должны дополнительно к руководству
пользоваться при техническом обслуживании.
2.2. В разделе «Общие указания» указывают
порядок технического обслуживания,
приводят указание по организации и
особенностям его проведения.
2.3. В разделе «Требования к техническим
средствам» указывают минимальный состав
технических средств, обеспечивающий
работу программы.
2.4. В разделе «Описание функций» указывают:
-
максимальный состав технических
средств, проверяемых этой программой; -
описание совместного функционирования
технических средств и программы с
указанием метода обработки ошибок; -
описание организации входных и выходных
данных, используемых при обслуживании
технических средств; -
описание взаимодействий устройств с
программой, результатов взаимодействий,
с выводом результатов работы программы.
Переиздание.
Ноябрь 1987 г.
Конец
формы
ГОСТ 19.508-79
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
РУКОВОДСТВО ПО ТЕХНИЧЕСКОМУ ОБСЛУЖИВАНИЮ
Требования к содержанию и оформлению
Unified system for program documentation. Maintenance manual. Requirements for contents and form of presentation
МКС 35.080
Дата введения 1981-01-01
Постановлением Государственного комитета CCCР по стандартам от 11 декабря 1979 г. N 4753 дата введения установлена 01.01.81
ПЕРЕИЗДАНИЕ. Январь 2010 г.
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство по техническому обслуживанию», определенного ГОСТ 19.101-77, и распространяется на тестовые и диагностические программы, используемые при обслуживании технических средств.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство по техническому обслуживанию должно содержать следующие разделы:
введение;
общие указания;
требования к техническим средствам;
описание функций.
В зависимости от особенностей документа допускается вводить дополнительные разделы.
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Введение» указывают назначение руководства, перечень эксплуатационных документов, которыми должны дополнительно к руководству пользоваться при техническом обслуживании.
2.2. В разделе «Общие указания» указывают порядок технического обслуживания, приводят указание по организации и особенностям его проведения.
2.3. В разделе «Требования к техническим средствам» указывают минимальный состав технических средств, обеспечивающий работу программы.
2.4. В разделе «Описание функций» указывают:
максимальный состав технических средств, проверяемых этой программой;
описание совместного функционирования технических средств и программы с указанием метода обработки ошибок;
описание организации входных и выходных данных, используемых при обслуживании технических средств;
описание взаимодействий устройств с программой, результатов взаимодействий, с выводом результатов работы программы.