Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р

Постановлением Государственного комитета стандартов Совета Министров СССР от 12 января 1979 г. ¹ 74 срок введения установлен

с 01.01. 1980 г.

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство программиста», определённого ГОСТ 19.101-77 .

Стандарт полностью соответствует СТ СЭВ 2095-80.

1. ОБЩИЕ ПОЛОЖЕНИЯ

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

Составление информационной части (аннотации и содержания) является обязательным.

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

• назначение программы;
• условия выполнения программы;
• выполнение программы;
• сообщения оператору.

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

2.1. В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

2.2. В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

(Измененная редакция, Изм. № 1).

2.3. В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы, а также ответы программы на эти команды.

(Измененная редакция, Изм. № 1).

2.4. В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).

2.5. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

(Измененная редакция, Изм. № 1).

2.6. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.

(Введен дополнительно, Изм. № 1).

* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)

Введен в действие постановлением Государственного комитета СССР по стандартам от 12 января 1979 г. N 74

Межгосударственный стандарт ГОСТ 19.505-79

"ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ. РУКОВОДСТВО ОПЕРАТОРА. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ"

Unified system for program documentation. Operation"s guide. Reqirements for contents and form of presentation

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа "Руководство оператора", определенного ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2096-80.

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

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

Составление информационной части (аннотации и содержания) является обязательным.

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

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

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

выполнение программы;

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

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

(Измененная редакция, Изм. N 1).

2.1. В разделе "Назначение программы" должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

2.2. В разделе "Условия выполнения программы" должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

2.3. В разделе "Выполнение программы" должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.

2.2, 2.3. (Измененная редакция, Изм. N 1).

2.4. (Исключен, Изм. N 1).

2.5. В разделе "Сообщения оператору" должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).

2.6. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

(Измененная редакция, Изм. N 1).

2.7. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.

(Введен дополнительно, Изм. N 1).

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

ЕДИНАЯ СИСТЕМА
ПРОГРАММНОЙ ДОКУМЕНТАЦИИ

РУКОВОДСТВО ОПЕРАТОРА

ТРЕБОВАНИЯ К СОДЕРЖАНИЮ
И ОФОРМЛЕНИЮ

Издание (январь 2002 г.) с Изменением № 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

Постановлением Государственного комитета СССР по стандартам от 12 января 1979 г. № 74 дата введения установлена

01.01.80

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа "Руководство оператора", определенного ГОСТ 19.101-77 .

Стандарт полностью соответствует СТ СЭВ 2096-80.

1. ОБЩИЕ ПОЛОЖЕНИЯ

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

Составление информационной части (аннотации и содержания) является обязательным.

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

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

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

выполнение программы;

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

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

(Измененная редакция, Изм. № 1).

2.1. В разделе "Назначение программы" должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

2.2. В разделе "Условия выполнения программы" должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т. п.).

2.3. В разделе "Выполнение программы" должны быть: указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведены описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.

2.2, 2.3. (Измененная редакция, Изм. № 1).

2.4. (Исключен, Изм. № 1).

2.5. В разделе "Сообщения оператору" должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т. п.).

2.6. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

(Измененная редакция, Изм. № 1).

2.7. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.

(Введен дополнительно, Изм. № 1).

Как писать руководство оператора по ГОСТ 19.505-79?

Создан 16.02.2010 19:41:18

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

и устанавливают в соответствии с.

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

В аннотации привести следующую фразу: «Настоящее руководство распространяется исключительно на программу и не заменяет учебную, справочную литературу, руководства от производителя и прочие источники, освещающие работу с операционной системы». Допустимо создание подраздела «Назначение руководства» или «Рекомендации по ».

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

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

«...должны быть указаны сведения о назначении программы». Сведения о назначении программы изложены в основополагающем документе – в.

Функциональное назначение

назначением программы является предоставление возможности в формате rtf.

Эксплуатационное назначение

Программа должна эксплуатироваться в профильных подразделениях на объектах заказчика.

Пользователями программы должны являться сотрудники профильных подразделений объектов заказчика.

Состав функций

Программа обеспечивает возможность выполнения перечисленных ниже функций:

1. Функции создания нового (пустого) ;
2. Функции открытия (загрузки) существующего файла;
3. Функции редактирования открытого (далее - текущего) файла путем, замены, удаления файла с применением стандартных устройств ввода;
4. Функции редактирования текущего файла с применением буфера обмена;
5. Функции сохранения файла с исходным именем;
6. Функции сохранения файла с именем, отличным от исходного;
7. Функции отправки содержимого текущего файла электронной почтой с помощью внешней клиентской почтовой программы;
8. Функции вывода в строковом (подсказок);
9. Функции интерактивной справочной системы;
10. Функции отображения программы, версии программы, копирайта и комментариев разработчика.

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

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

Создаем соответствующие подразделы. Поскольку «аппаратурных» звучит старообразно, меняем его на «технических».

Климатические условия эксплуатации

Климатические, при которых должны обеспечиваться заданные характеристики, должны удовлетворять, предъявляемым к в части условий их эксплуатации.

Минимальный состав технических средств

В состав технических средств должен входить IBM-совместимый персональный компьютер (), включающий в себя:

1. Pentium-1000 с тактовой частотой, ГГц - 10, не менее;
2. материнскую плату с FSB, ГГц - 5, не менее;
3. объемом, Тб - 10, не менее;
4. и так далее…

Минимальный состав программных средств

Используемые программой, должны быть представлены локализованной версией операционной системы. Допускается использование пакета обновления такого-то.

Требования к персоналу (пользователю)

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

Системный администратор должен иметь высшее профильное образование и компании-производителя операционной системы. В перечень задач, выполняемых системным администратором, должны входить:

1. задача поддержания технических средств;
2. задачи установки (инсталляции) и поддержания – операционной системы;
3. задача установки (инсталляции) программы.

Пользователь программы (оператор) должен обладать практическими навыками работы с операционной системы.

Персонал должен быть аттестован на II квалификационную группу по электробезопасности (для работы с конторским оборудованием).

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

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

Автоматически, «пальцами», создаем подразделы:

Во время о но программы осуществлялась отдельно, запуск - отдельно. В нынешних условиях загрузка и запуск объединились в единую. Ключевая фраза подраздела «Требования к количеству и квалификации персонала» технического задания - «пользователь программы (оператор) должен обладать работы с графическим пользовательским интерфейсом операционной системы» снимает с автора обязанность подробно расписывать способы загрузки и запуска программы... Не обязан разработчик разжевывать оператору приемы работы с графическим пользовательским интерфейсом операционной системы. За исключением случаев применения в программе элементов интерфейса, не свойственных операционной системе.

Выполнение функции создания нового (безымянного) файла

В случае успешного выполнения указанной функции на рабочем столе будет отображено окно (см. Загрузка и запуск программы). Программа готова к вводу и редактированию.

Примечание - При успешном завершении загрузки и запуска программа автоматически создаст новый (безымянный) файл.

Подход прост. Действие - результат, см. Схема «действие - результат» в совокупности с подходом «делай, как я сказал» . Ошибочный результат – сообщение об ошибке.

Сторонники «дружественного» отношения к пользователю вправе озаглавить подраздел, к примеру, так - «Создание нового файла». Ни буква, ни дух этому не препятствуют. В настоящем документе исключено прямое обращение к пользователю. Отсутствуют «откройте», «нажмите», «укажите» и пр. Применены штампы «следует открыть», «следует нажать» и им подобные (согласно ГОСТ 2.105-95).

Выполнение функции открытия (загрузки) существующего файла

Выполнение указанной функции возможно любым из перечисленных ниже способов:

В результате на рабочем столе будет отображено окно Открыть .

Примечание - Программа обеспечивает возможность загрузки файлов только с расширением *.rtf.

Выбор требуемого файла осуществляется способами, детальные сведения о которых изложены в руководстве пользователя операционной системы. Завершается выполнение функции нажатием кнопки Открыть .

В случае успешного (выполнения программой функции) открытия файла на рабочем столе будет отображено окно с открытого (текущего) файла. Главного окна программы будет отображать полный текущего файла.

Неразумно брать на себя ответственность уважаемого г-на Торвальдса и компании, тем более - г-на Гейтса. Не должно настоящее руководство заменять учебную, справочную литературу, руководства от производителей ОС и прочие источники информации, освещающие работу с графическим пользовательским интерфейсом операционной системы. Понадобится пользователю открыть файл средствами операционной системы - пусть изучает матчасть и расширяет, тем самым, свой кругозор.

Выполнение функции редактирования текущего файла путем ввода, замены, удаления содержимого файла с применением устройств ввода

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

Редактирование текущего файла путем ввода текста с устройств ввода

• в стартовой позиции;
• (набор) текста.

Для пометки стартовой позиции редактирования следует переместить курсор в требуемую позицию текста и нажать левую клавишу. В требуемой позиции будет отображен курсор.

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• текста, подлежащего;
• ввод (набор) текста.

Для выделения текста, подлежащего замене, следует:

• переместить курсор в стартовую позицию;
• курсор в конечную позицию фрагмента.

Фрагмент текста будет выделен цветом.

Редактирование текущего файла путем удаления содержимого с применением устройств ввода

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• выделение текста, подлежащего удалению;

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

может быть выполнено любым из перечисленных ниже способов:

1. нажатием клавиши Delete ;
2. нажатием сочетания клавиш Ctrl+X ;
3. нажатием клавиши BackSpace .

Выполнение функции редактирования текущего файла с применением буфера обмена операционной системы

Указанная функция включает в себя перечисленные ниже операции:

• операцию (фрагмента) файла;
• операцию содержимого обмена в файл.

Выполнение операции копирования (фрагмента) файла

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• текста, подлежащего копированию;

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

Примечание - При отсутствии выделенного (фрагмента) текста выполнение операции копирования невозможно. Кнопка копирования недоступна и имеет вид , пункт меню Копировать недоступен.

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

Выполнение операции вставки содержимого буфера обмена в файл

Последовательность действий, требуемая для выполнения указанной операции, включает в себя:

• пометку (указание) в тексте текущего файла стартовой позиции вставки;
• вставку содержимого буфера обмена.

Примечание - При отсутствии содержимого в буфере обмена выполнение операции вставки невозможно. Кнопка вставки недоступна и имеет вид , пункт меню Вставить недоступен.

Для пометки стартовой позиции вставки следует переместить курсор в требуемую позицию текста и нажать левую клавишу. В требуемой позиции будет отображен курсор.

Выполнение указанной операции возможно любым из перечисленных ниже способов:

В результате выполнения указанной операции фрагмент текста, содержащегося в буфере обмена, будет помещен в требуемую позицию текущего файла.

Выполнение функции сохранения файла с исходным именем

Выполнение указанной функции возможно любым из перечисленных ниже способов:

Наверное, достаточно. Нет смысла дублировать (фактически) описания выполнения типовых функций программы в документе.

Завершение работы программы

Завершение работы программы обеспечиваются стандартными средствами операционной системы.

Выполнение указанной функции возможно любым из перечисленных ниже способов:

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

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

Поскольку программа не консольная (с интерфейсом строки), а с графическим пользовательским интерфейсом, классических текстовых сообщений не предвидится. Сообщения об ошибках отображаются в виде окон на рабочем столе.

«описание их содержания»

Ошибка сохранения файла

При попытке сохранения файла с именем уже существующего файла на рабочем столе программы будет отображено сообщение об ошибке.

«и соответствующие действия оператора»

Для сохранения файла с именем уже существующего файла следует нажать кнопку Да .

Для сохранения файла с именем, отличным от имени существующего файла, следует:

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

Об иллюстрациях

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

В настоящем руководстве оператора в качестве иллюстраций используются (окна), отображаемые на рабочем столе.

О приложениях

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

Все, что душе угодно.

Выводы

Утверждения отдельных граждан о том, что 19-я система стандартов безнадежно устарела и не может быть применена для разработки современных программ с графическим пользовательским интерфейсом, а также для разработки и выпуска качественной к программным изделиям - чушь.

Причиной для таких утверждений, судя по всему, стали:

• обычная лень - нежелание открыть ЕСПД и один-единственный раз (!) во всем разобраться;
• тяга к оформительству, подогреваемая отдельными маститыми «техническими писателями»;
• тяга к буржуйским стандартам (ибо нет пророка в своем отечестве);
• и еще много чего.

Отдельно о буржуйских стандартах. Через некоторое время планируется опубликовать сравнительный анализ ГОСТ 19-й системы и IEEE Std 830-1998, а также IEEE Std 1063-2001 с целью показать:

• превосходство советских стандартов 25-летней давности в целом;
• «цельнотянутость» буржуйских с наших.

Примечание от 17.02.2010 г. - указанных документов дан в статье «».

• ГОСТ 19.505-79 Единая система программной документации. Руководство оператора. Требования к содержанию и оформлению

Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р

Постановлением Государственного комитета стандартов Совета Министров СССР от 12 января 1979 г. ¹ 74 срок введения установлен

с 01.01. 1980 г.

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство программиста», определённого ГОСТ 19.101-77 .

Стандарт полностью соответствует СТ СЭВ 2095-80.

1. ОБЩИЕ ПОЛОЖЕНИЯ

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

Составление информационной части (аннотации и содержания) является обязательным.

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

• назначение программы;
• условия выполнения программы;
• выполнение программы;
• сообщения оператору.

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

2.1. В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

2.2. В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

(Измененная редакция, Изм. № 1).

2.3. В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы, а также ответы программы на эти команды.

(Измененная редакция, Изм. № 1).

2.4. В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).

2.5. Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

(Измененная редакция, Изм. № 1).

2.6. В приложения к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.

(Введен дополнительно, Изм. № 1).

* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)