Руководство оператора шаблон

Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).

В 2004 — 2005 годах был опубликован минимально необходимый набор «учебно-тренировочных» документов на программы, включающий техническое задание на программу по ГОСТ 19.201-78, программу и методику испытаний по ГОСТ 19.301-79, руководство оператора по ГОСТ 19.505-79. Этого достаточно для разработки программы, проведения испытаний и сдачи ее заказчику. Редакция от 23.01.2022.

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

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

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

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

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

Состав руководства

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

• назначение программы (1);
• условия выполнения программы (2);
• выполнение программы (3);
• сообщения оператору (4).

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

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

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

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

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

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

Функциональным назначением программы является предоставление пользователю возможности работы с текстовыми документами в формате rtf.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• Загрузка и запуск программы;
• Выполнение программы;
• Завершение работы программы.

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

Загрузка и запуск программы

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

В случае успешного запуска программы на рабочем столе будет отображено Главное окно программы.

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

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

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

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

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

1. последовательным выбором пунктов меню Файл-Создать;
2. нажатием кнопки .

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

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

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

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

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

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

1. последовательным выбором пунктов меню Файл-Открыть;
2. нажатием кнопки ;
3. последовательным нажатием клавиш Ctrl и O (сочетанием клавиш Ctrl+O).

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

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

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

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

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

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

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

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

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

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

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

Далее следует вводить (набирать) требуемый текст с клавиатуры. По мере ввода символов изображение курсора будет смещаться вправо.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. последовательным выбором пунктов меню Правка-Копировать;
2. нажатием кнопки ;
3. нажатием сочетания клавиш Ctrl+C.

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

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

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

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

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

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

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

1. последовательным выбором пунктов меню Правка-Вставить;
2. нажатием кнопки ;
3. нажатием сочетания клавиш Ctrl+V.

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

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

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

1. последовательным выбором пунктов меню Файл-Сохранить;
2. нажатием кнопки ;
3. последовательным нажатием клавиш Ctrl и S (сочетанием клавиш Ctrl+S).

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

…

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

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

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

или

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

1. последовательным выбором пунктов меню Файл-Выход (см. рисунок такой-то);
2. нажатием кнопки .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

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

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

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

Примечание от 17.02.2010 г. — Сравнительный анализ указанных документов дан в статье «Как писать руководство пользователя? Часть I».

Курсовая работа
по дисциплине

«Системы
управления базами данных»

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

выдано
отдельно

Содержание работы:

1. Титульный
   лист

2. Содержание

3. Техническое
   задание на разработку ( в соответствии
   с ГОСТ)

4. Информационно-логическая
   модель предметной области

5. Концептуальная
   модель БД

6. Алгоритмы
   работы с БД

7. Проектирование
   интерфейса

8. Программная
   реализация информационной системы

9. Руководства
   оператору и программисту ( в соответствии
   с ГОСТ)

10. Заключение

11. Список
    литературы

12. Приложения
    (в приложении должен быть обязательно
    фрагмент программы).

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

Общие
требования к программе:

1. Программа
   должна иметь справочную подсистему.

2. Не
   менее 10 запросов к базе данных.

3. Отчеты
   –не менее 5
   шт.

4. Программа
   должна выполнять все функции
   предусмотренные ТЗ.

5. База
   данных и интерфейс пользователя должны
   быть реализованы СУБД MS
   SQL
   Server
   (2005-2008 не ниже) и среде DELPHI
   (желательно 9-10 версия).

Правила
оформления курсовой работы

При
оформлении пояснительных записок
следует придерживаться ГОСТ 7.32-91 (ИСО
5966-82) «Отчет по научно-исследовательской
работе. Титульный лист должен быть
следующего вида.

МИНИСТЕРСТВО
ОБРАЗОВАНИЯ И НАУКИ рОССИЙСКОЙ ФЕДЕРАЦИИ

(МИНОБРНАУКИ РОССИИ)

Федеральное
государственное бюджетное образовательное
учреждение высшего профессионального
образования

«Санкт-Петербургский
государственный политехнический
университет» (ФГБОУ ВПО «СПбГПУ»)

Институт
менеджмента и информационных технологий

(филиал)
федерального государственного бюджетного
образовательного учреждения высшего
профессионального образования

«Санкт-Петербургский
государственный политехнический
университет» в г.Череповце (ИМИТ «СПбГПУ»)

.

Разработка
БАЗЫ ДАННЫХ «(НАЗВАНИЕ ПРЕДМЕТНОЙ
ОБЛАСТИ)»

в среде СУБД

Расчетно-пояснительная
записка

к курсовой работе

Листов 25

Руководитель,

канд.
тех. наук, доцент

Щегряев Н.А.

Исполнитель,

Студент
О.551
Петров
А.В

2012
г.

Рисунок
1- Пример титульного листа
расчетно-пояснительной записки

Примерное
содержание пояснительной записки по
курсу «СУБД» должно включать:

Содержание

Стр.

Техническое
ЗАДАНИЕ…………………………………………………………………………………….
3

1.Иннформационно-логическая
модель предметной обласТИ …..
7

2.
концептуальной
моделЬ БАЗЫ
ДАННЫХ.…………………………………………..
11

2.1.
Разработка концептуальной схемы
БД……………………………………………..11

2.2.
Разработка алгоритмов контроля
целостности и согласованности БД………….13

2.3.
Разработка алгоритмов для работы с
БД…………………………………………..15

3.
Проектирование
интерфейса пользователя
………………………………….. 17

3.1.
Выбор интерфейса……………………………………………………………………18

3.2.
Построение графа диалога
……………………………………………………………………….
19

3.3.
Разработка форм ввода-вывода
информации………………………………………………..
20

4.ПРОГРАММНАЯ
РЕАЛИЗАЦИЯ ИНФОРМАЦИОННОЙ

СИСТЕМЫ………………………………………………..……..………………………..23

5.
Руководство пользователя
…………………………………………………….
24

Заключение

…………………………………………………………………………………………………..
26

литературА
…………..
……………………………………………………………………………………..
28

Приложение
А.ЛИСТИНГ ПРОГРАММЫ
(фрагмент)………………………………………
29

Руководство оператора

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

• учитывайте
интересы пользователей — руководство
должно содержать все инструкции,
необходимые пользователю;

• излагайте ясно,
используйте короткие предложения;

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

• будьте точны и
рациональны — длинные и запутанные
руководства обычно никто не читает,
например, лучше привести рисунок формы,
чем долго ее описывать.

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

• общие сведения
о программном продукте;

• описание
установки;

• описание запуска;

• инструкции по
работе (или описание пользовательского
интерфейса);

• сообщения
пользователю.

Раздел
«Общие сведения о программе» обычно
содержит наименование программного
продукта, краткое описание его функций,
реализованных ме­тодов и возможных
областей применения.

Раздел
Установка обычно содержит подробное
описание действий по установке
программного продукта и сообщений,
которые при этом могут быть получены.

В
разделе Запуск, как правило, описаны
действия по запуску программ­ного
продукта и сообщений, которые при этом
могут быть получены.

Раздел
Инструкции по работе обычно содержит
описание режимов ра­боты, форматов
ввода-вывода информации и возможных
настроек.

Раздел
Сообщения пользователю должен содержать
перечень возмож­ных сообщений, описание
их содержания и действий, которые
необходимо предпринять по этим сообщениям.

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

По
ГОСТ 19.503-79 руководство системного
программиста должно со­держать всю
информацию, необходимую для установки
программного обес­печения, его
настройки и проверки работоспособности.
Кроме того, как ука­зывалось выше, в
него часто включают и описание необходимого
обслужи­вания, которое раньше
приводилось в руководстве оператора
(ГОСТ 19.505-79) и/или руководстве по
техническому обслуживанию (ГОСТ
19.508-79). В настоящее время данную схему
используют для составления руководства
системному администратору.

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

• общие сведения
о программном продукте,

• структура,

• настройка,

• проверка,

• дополнительные
возможности,

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

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

В
разделе Структура программы должны
быть приведены сведения о структуре
программы, ее составных частях, о связях
между составными ча­стями и о связях
с другими программами.

В
разделе Настройка программы должно
быть приведено описание дей­ствий по
настройке программы на условия
практического применения.

В
разделе Проверка программы должно быть
приведено описание спо­собов проверки
работоспособности программы, например
контрольные при­меры.

В
разделе Дополнительные возможности
должно быть приведено опи­сание
дополнительных возможностей программы
и способов доступа к ним.

В
разделе Сообщения системному программисту
должны быть указаны тексты сообщений,
выдаваемых в ходе выполнения настройки
и проверки программы, а также в ходе ее
выполнения, описание их содержания и
дейст­вий, которые необходимо
предпринять по этим сообщениям.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

• #
• #
• #
• #
• #
• #
• #
• #
• #
• #
• #