5 Правила выполнения эксплуатационной документации ЕСПД

Формуляр по ГОСТ 19.501-78

Формуляр по ГОСТ 19.501-78

Формуляр на программу по ГОСТ 19.501-78 (пример)

Формуляр по ГОСТ 19.501-78Формуляр по ГОСТ 19.501-78 - диаграммма Гантта

Смотрите:
Общие положения
Содержание разделов

Общие положения

Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78.

Информационную часть (аннотацию 0 Аннотация [из подр. 1.1 ГОСТ 19.501-78] и содержание) допускается в документ не включать [из подр. 1.1 ГОСТ 19.501-78]

В основную часть документа должны входить следующие разделы:

Состав и содержание разделов документа определяют в соответствии с особенностями программных изделий.

При необходимости допускается дополнять документ другими разделами или объединять отдельные разделы, а также помещать их в приложениях [из подр. 1.2 ГОСТ 19.501-78]

Содержание разделов

Смотрите:
Общие указания
Общие сведения
Основные характеристики
Комплектность
Периодический контроль основных характеристик при эксплуатации и хранении
Свидетельство о приемке
Свидетельство об упаковке и маркировке
Гарантийные обязательства
Сведения о рекламациях
Сведения о хранении
Сведения о закреплении программного изделия при эксплуатации
Сведения об изменениях
Особые пометки
Приложения

Общие указания

В разделе «Общие указания» приводят общие указания для обслуживающего персонала по эксплуатации программного изделия, заполнению и ведению его формуляра, например:

«Перед эксплуатацией необходимо внимательно ознакомиться с соответствующими эксплуатационными документами (приводятся наименования документов). Формуляр должен находиться в подразделении, ответственном за эксплуатацию программного изделия» [из подр. 2.1 ГОСТ 19.501-78]

Общие сведения

В разделе «Общие сведения» указывают наименование программного изделия 2.1 Наименование программного изделия [из подр. 2.2 ГОСТ 19.501-78], его обозначение 2.2 Обозначение программного изделия [из подр. 2.2 ГОСТ 19.501-78], наименование предприятия-изготовителя 2.3 Наименование предприятия-изготовителя [из подр. 2.2 ГОСТ 19.501-78], номер программного изделия предприятия 2.4 Номер программного изделия предприятия [из подр. 2.2 ГОСТ 19.501-78] и другие общие сведения о программном изделии 2.5 Другие общие сведения о программном изделии [из подр. 2.2 ГОСТ 19.501-78] [из подр. 2.2 ГОСТ 19.501-78]

Основные характеристики

В разделе «Основные характеристики» приводят необходимые при эксплуатации программного изделия значения основных характеристик (например, функциональных 3.1 Необходимые при эксплуатации программного изделия значения основных функциональных характеристик [из подр. 2.3 ГОСТ 19.501-78], надежности 3.2 Необходимые при эксплуатации программного изделия значения основных характеристик надежности [из подр. 2.3 ГОСТ 19.501-78] и др.) [из подр. 2.3 ГОСТ 19.501-78]

Комплектность

В разделе «Комплектность» перечисляют все непосредственно входящие в программное изделие другие программные изделия 4.1 Входящие в программное изделие другие программные изделия [из подр. 2.4 ГОСТ 19.501-78] и документацию в соответствии с комплектностью, указанной в технических условиях на программное изделие 4.2 Документация в соответствии с комплектностью, указанной в технических условиях [из подр. 2.4 ГОСТ 19.501-78].

При наличии ведомости эксплуатационных документов в формуляре делают на нее ссылку без перечисления эксплуатационных документов (форма 1 обязательного приложения) [из подр. 2.4 ГОСТ 19.501-78]

- Форма 1 обязательного приложения к ГОСТ 19.501-78

Периодический контроль основных характеристик при эксплуатации и хранении

В разделе «Периодический контроль основных характеристик при эксплуатации и хранении» указывают наименование измерения проверяемых характеристик 5.1 Наименование измерения проверяемых характеристик [из подр. 2.5 ГОСТ 19.501-78], требуемую периодичность контроля 5.2 Требуемая периодичность контроля [из подр. 2.5 ГОСТ 19.501-78] (форма 2 приложения) [из подр. 2.5 ГОСТ 19.501-78]

- Форма 2 приложения к ГОСТ 19.501-78

Свидетельство о приемке

В разделе «Свидетельство о приемке» приводят свидетельство о приемке программного изделия, подписанное лицами, ответственными за приемку (форма 3 приложения) [из подр. 2.6 ГОСТ 19.501-78]

- Форма 3 приложения к ГОСТ 19.501-78

Свидетельство об упаковке и маркировке

В разделе «Свидетельство об упаковке и маркировке» помещают сведения об упаковке программного изделия, подписанные лицами, ответственными за упаковку (форма 4 приложения) [из подр. 2.7 ГОСТ 19.501-78]

- Форма 4 приложения к ГОСТ 19.501-78

Гарантийные обязательства

В разделе «Гарантийные обязательства» приводят гарантийные обязательства предприятия-изготовителя [из подр. 2.8 ГОСТ 19.501-78]

Сведения о рекламациях

В разделе «Сведения о рекламациях» приводят краткое изложение порядка предъявления рекламации и регистрируют все предъявленные рекламации, их содержание и принятые меры (форма 5 приложения) [из подр. 2.9 ГОСТ 19.501-78]

- Форма 5 приложения к ГОСТ 19.501-78

Сведения о хранении

В разделе «Сведения о хранении» указывают сроки хранения программного изделия (форма 6 приложения) [из подр. 2.10 ГОСТ 19.501-78]

- Форма 6 приложения к ГОСТ 19.501-78

Сведения о закреплении программного изделия при эксплуатации

В разделе «Сведения о закреплении программного изделия при эксплуатации» указывают фамилии и должности лиц, за которыми закрепляют программное изделие (форма 7 приложения) [из подр. 2.11 ГОСТ 19.501-78]

- Форма 7 приложения к ГОСТ 19.501-78

Сведения об изменениях

В разделе «Сведения об изменениях» указывают основание для внесения изменений, содержание изменений с указанием его порядкового номера, а также должность, фамилию и подпись лица, ответственного за проведение изменения (форма 8 приложения) [из подр. 2.12 ГОСТ 19.501-78]

- Форма 8 приложения к ГОСТ 19.501-78

Особые пометки

В разделе «Особые пометки» оставляют несколько чистых листов для специальных отметок, которые вносят во время эксплуатации программного изделия [из подр. 2.13 ГОСТ 19.501-78]

Приложения

В качестве приложений к формуляру могут быть справочные материалы и дополнительные документы (например, журнал учета работы), необходимые при эксплуатации программного изделия [из подр. 2.14 ГОСТ 19.501-78]

Руководство оператора по ГОСТ 19.505-79

Руководство оператора по ГОСТ 19.505-79

Руководство оператора по ГОСТ 19.505-79Руководство оператора по ГОСТ 19.505-79 - диаграмма Гантта

Смотрите:
Общие положения
Содержание разделов

Общие положения

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации 0 Аннотация [из п. 1.1 ГОСТ 19.505-79] и содержания) является обязательным [из п. 1.1 ГОСТ 19.505-79]

Руководство оператора должно содержать следующие разделы:

В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из п. 1.2 ГОСТ 19.505-79]

Содержание разделов

Смотрите:
Назначение программы
Условия выполнения программы
Выполнение программы
Сообщения оператору
Приложения

Назначение программы

В разделе «Назначение программы» должны быть указаны сведения о назначении программы 1.1 Сведения о назначении программы [из п. 2.1 ГОСТ 19.505-79] и информация, достаточная для понимания функций программы и ее эксплуатации 1.2 Информация, достаточная для понимания функций программы и ее эксплуатации [из п. 2.1 ГОСТ 19.505-79] [из п. 2.1 ГОСТ 19.505-79]

Условия выполнения программы

В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы 2.1 Условия, необходимые для выполнения программы [из п. 2.2 ГОСТ 19.505-79] (минимальный и (или) максимальный состав аппаратурных 2.2 Минимальный и (или) максимальный состав аппаратурных средств [из п. 2.2 ГОСТ 19.505-79] и программных средств 2.3 Минимальный и (или) максимальный состав программных средств [из п. 2.2 ГОСТ 19.505-79] и т.п.) [из п. 2.2 ГОСТ 19.505-79]

Выполнение программы

В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку 3.1 Последовательность действий оператора, обеспечивающих загрузку программы [из п. 2.3 ГОСТ 19.505-79], запуск 3.2 Последовательность действий оператора, обеспечивающих запуск программы [из п. 2.3 ГОСТ 19.505-79], выполнение 3.3 Выполнение программы [из п. 2.3 ГОСТ 19.505-79] и завершение программы 3.6 Последовательность действий оператора, обеспечивающих завершение программы [из п. 2.3 ГОСТ 19.505-79], приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы 3.4 Описание функций, формата и возможных вариантов команд управления выполнением программы [из п. 2.3 ГОСТ 19.505-79], а также ответы программы на эти команды 3.5 Ответы программы [из п. 2.3 ГОСТ 19.505-79] [из п. 2.3 ГОСТ 19.505-79]

Сообщения оператору

В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы 4.1 Тексты сообщений, выдаваемых в ходе выполнения программы [из п. 2.5 ГОСТ 19.505-79], описание их содержания и соответствующие действия оператора 4.2 Описание содержания текстов сообщений и соответствующих действий оператора [из п. 2.5 ГОСТ 19.505-79] (действия оператора в случае сбоя 4.3 Действия оператора в случае сбоя [из п. 2.5 ГОСТ 19.505-79], возможности повторного запуска программы 4.4 Возможности повторного запуска программы [из п. 2.5 ГОСТ 19.505-79] и т.п.) [из п. 2.5 ГОСТ 19.505-79]

Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками [из п. 2.6 ГОСТ 19.505-79]

Приложения

В приложения 5 Приложения [из п. 2.7 ГОСТ 19.505-79] к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства [из п. 2.7 ГОСТ 19.505-79]

Руководство системного программиста по ГОСТ 19.503-79

Руководство системного программиста по ГОСТ 19.503-79

Руководство системного программиста по ГОСТ 19.503-79Руководство системного программиста по ГОСТ 19.503-79 - диаграмма Гантта

Смотрите:
Общие положения
Содержание разделов

Общие положения

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации 0 Аннотация [из п. 1.1 ГОСТ 19.503-79] и содержания) является обязательным [из п. 1.1 ГОСТ 19.503-79]

Руководство системного программиста должно содержать следующие разделы:

В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.

В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы» [из п. 1.2 ГОСТ 19.503-79]

Содержание разделов

Смотрите:
Общие сведения о программе
Структура программы
Настройка программы
Проверка программы
Дополнительные возможности
Сообщения системному программисту
Приложения

Общие сведения о программе

В разделе «Общие сведения о программе» должна быть указаны назначение 1.1 Назначение программы [из п. 2.1 ГОСТ 19.503-79] и функции программы 1.2 Функции программы [из п. 2.1 ГОСТ 19.503-79] и сведения о технических и программных средствах, обеспечивающих выполнение данной программы 1.3 Сведения о технических и программных средствах, обеспечивающих выполнение данной программы [из п. 2.1 ГОСТ 19.503-79] [из п. 2.1 ГОСТ 19.503-79]

Структура программы

В разделе «Структура программы» должны быть приведены сведения о структуре программы 2.1 Сведения о структуре программы [из п. 2.2 ГОСТ 19.503-79], ее составных частях 2.2 Сведения о составных частях программы [из п. 2.2 ГОСТ 19.503-79], о связях между составными частями 2.3 Сведения о связях между составными частями программы [из п. 2.2 ГОСТ 19.503-79] и о связях с другими программами 2.4 Сведения о связях с другими программами [из п. 2.2 ГОСТ 19.503-79] [из п. 2.2 ГОСТ 19.503-79]

Настройка программы

В разделе «Настройка программы» должно быть приведено описание действий по настройке программы на условия конкретного применения 3.1 Описание действий по настройке программы на условия конкретного применения [из п. 2.3 ГОСТ 19.503-79] (настройка на состав технических средств 3.2 Настройка программы на состав технических средств [из п. 2.3 ГОСТ 19.503-79], выбор функций 3.3 Выбор функций программы [из п. 2.3 ГОСТ 19.503-79] и др.)

При необходимости приводят поясняющие примеры 3.4 Поясняющие примеры (при необходимости) [из п. 2.3 ГОСТ 19.503-79] [из п. 2.3 ГОСТ 19.503-79]

Проверка программы

В разделе «Проверка программы» должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы 4.1 Описание способов проверки, позволяющих дать общее заключение о работоспособности программы [из п. 2.4 ГОСТ 19.503-79] (контрольные примеры 4.2 Контрольные примеры [из п. 2.4 ГОСТ 19.503-79], методы прогона 4.3 Методы прогона [из п. 2.4 ГОСТ 19.503-79], результаты 4.4 Результаты [из п. 2.4 ГОСТ 19.503-79]) [из п. 2.4 ГОСТ 19.503-79]

Дополнительные возможности

В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы 5.1 Описание дополнительных функциональных возможностей программы [из п. 2.5 ГОСТ 19.503-79] и способов их выбора 5.2 Описание способов выбора дополнительных функциональных возможностей программы [из п. 2.5 ГОСТ 19.503-79] [из п. 2.5 ГОСТ 19.503-79]

Сообщения системному программисту

В разделе «Сообщения системному программисту» должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки 6.1 Тексты сообщений, выдаваемых в ходе настройки программы [из п. 2.6 ГОСТ 19.503-79], проверки программы 6.2 Тексты сообщений, выдаваемых в ходе проверки программы [из п. 2.6 ГОСТ 19.503-79], а также в ходе выполнения программы 6.3 Тексты сообщений, выдаваемых в ходе выполнения программы [из п. 2.6 ГОСТ 19.503-79], описание их содержания и действий, которые необходимо предпринять по этим сообщениям 6.4 Описание содержания сообщений и действий, которые необходимо предпринять по этим сообщениям [из п. 2.6 ГОСТ 19.503-79] [из п. 2.6 ГОСТ 19.503-79]

Приложения

В приложении 7 Приложения [из п. 2.7 ГОСТ 19.503-79] к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из п. 2.7 ГОСТ 19.503-79]

Описание применения по ГОСТ 19.502-78

Описание применения по ГОСТ 19.502-78

Описание применения по ГОСТ 19.502-78Описание применения по ГОСТ 19.502-78 - диаграмма Гантта

Смотрите:
Назначение программы
Условия применения
Описание задачи
Входные и выходные данные
Приложения

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации 0 Аннотация [из п. 2 ГОСТ 19.502-78] и содержания) является обязательным [из п. 2 ГОСТ 19.502-78]

Текст документа должен состоять из следующих разделов:

[из п. 3 ГОСТ 19.502-78]

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы [из п. 4 ГОСТ 19.502-78]

Назначение программы

В разделе «Назначение программы» указывают назначение 1.1 Назначение программы [из п. 5 ГОСТ 19.502-78], возможности программы 1.2 Возможности программы [из п. 5 ГОСТ 19.502-78], ее основные характеристики 1.3 Основные характеристики программы [из п. 5 ГОСТ 19.502-78], ограничения, накладываемые на область применения программы 1.4 Ограничения, накладываемые на область применения программы [из п. 5 ГОСТ 19.502-78] [из п. 5 ГОСТ 19.502-78]

Условия применения

В разделе «Условия применения» указываются условия, необходимые для выполнения программы 2.1 Условия, необходимые для выполнения программы [из п. 6 ГОСТ 19.502-78] (требования к необходимым для данной программы техническим средствам 2.2 Требования к необходимым техническим средствам [из п. 6 ГОСТ 19.502-78], и другим программам 2.3 Требования к другим программам [из п. 6 ГОСТ 19.502-78], общие характеристики входной и выходной информации 2.4 Общие характеристики входной и выходной информации [из п. 6 ГОСТ 19.502-78], а также требования и условия организационного, технического и технологического характера 2.5 Требования и условия организационного, технического и технологического характера [из п. 6 ГОСТ 19.502-78] и т.п.) [из п. 6 ГОСТ 19.502-78]

Описание задачи

В разделе «Описание задачи» должны быть указаны определения задачи 3.1 Определения задачи [из п. 7 ГОСТ 19.502-78] и методы ее решения 3.2 Методы решения задачи [из п. 7 ГОСТ 19.502-78] [из п. 7 ГОСТ 19.502-78]

Входные и выходные данные

В разделе «Входные и выходные данные» должны быть указаны сведения о входных и выходных данных 4.1 Сведения о входных и выходных данных [из п. 7а ГОСТ 19.502-78] [из п. 7а ГОСТ 19.502-78]

Приложения

В приложение 5 Приложения [из п. 8 ГОСТ 19.502-78] к общему описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.) [из п. 8 ГОСТ 19.502-78]

Описание языка по ГОСТ 19.506-79

Описание языка по ГОСТ 19.506-79

- Описание языка по ГОСТ 19.506-79

Смотрите:
Общие положения
Содержание разделов

Общие положения

Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным [из п. 1.1 ГОСТ 19.506-79]

Описание языка должно содержать следующие разделы:

  • общие сведения;
  • элементы языка.

Допускается вводить разделы:

В зависимости от особенностей языка допускается объединять отдельные разделы или вводить новые [из п. 1.2 ГОСТ 19.506-79]

Содержание разделов

Смотрите:
Общие сведения
Элементы языка
Способы структурирования программы
Средства обмена данными
Встроенные элементы
Средства отладки программы
прил.

Общие сведения

В разделе «Общие сведения» должны быть указаны назначение и описание общих характеристик языка, его возможностей, основных областей применения и другие сведения [из п. 2.1 ГОСТ 19.506-79]

Элементы языка

В разделе «Элементы языка» должно быть указано описание синтаксиса и семантики базовых и составных элементов языка [из п. 2.2 ГОСТ 19.506-79]

Способы структурирования программы

В разделе «Способы структурирования программы» должны быть указаны способы вызова процедур передачи управления и другие элементы структурирования программы [из п. 2.3 ГОСТ 19.506-79]

Средства обмена данными

В разделе «Средства обмена данными» должно быть приведено описание языковых средств обмена данными (например, средства ввода-вывода, внутреннего обмена данными и т. п.) [из п. 2.4 ГОСТ 19.506-79]

Встроенные элементы

В разделе «Встроенные элементы» должны быть приведены описание встроенных в язык элементов (например, функции, классы и т. п.) и правила их использования [из п. 2.5 ГОСТ 19.506-79]

Средства отладки программы

В разделе «Средства отладки программы» должно быть приведено описание имеющихся в языке средств отладки программ, семантики этих средств, даны рекомендации по их применению [из п. 2.8 ГОСТ 19.506-79]

При необходимости содержание разделов должно быть пояснено примерами [из п. 2.9 ГОСТ 19.506-79]

прил.

В прил. к описанию языка могут быть включены дополнительные материалы (формализованные описания языковых средств, иллюстрации, таблицы, графики, формы бланков и т.п.) [из п. 2.10 ГОСТ 19.506-79]

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. +7(967) 044-84-77 или в форме Контакты.

Copyright © «Техническая документация» 2008. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика