Пример оформления руководства оператора по если - Большая энциклопедия инструкций и руководств

ГОСТ 19.505-79

Группа Т55

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

Единая система программной документации

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

Требования к содержанию и оформлению

Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation

МКС 35.080

Дата введения 1980-01-01

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

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

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

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

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

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

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

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

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

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

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

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

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

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

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

2. СОДЕРЖАНИЕ РАЗДЕЛОВ

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).

В 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

…

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

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

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

или

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

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

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

В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы (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».

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

Что такое служебная записка

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

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

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

Бесплатно составить кадровые документы по готовым шаблонам

Виды служебных записок

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

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

Заказать электронную подпись для работы с личным кабинетом на mos.ru

Получить через час

Пояснительная. Такая «служебка» содержит сведения о каких-либо внутренних процессах в организации. Например, о введении новой электронной системы работы с рекламациями. Или о переводе внутрикорпоративных коммуникаций в электронную форму — хелпдеск, форумы и т.п.

Объяснительная. В такой записке раскрывают причины той или иной проблемы, события или нарушения. Например, причины допущенных ошибок, выпуска бракованной продукции, выхода из строя оборудования или ПО.

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

Материальная. Такие «служебки» нужны, чтобы запросить те или иные ресурсы. Например, закупить канцелярию, компьютеры, СИЗ; отремонтировать или заменить оборудование и проч.

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

Различия между служебной запиской, докладной и объяснительной

Законодательство не делает различия между служебными, докладными и объяснительными записками. К примеру, в разделе 2 Инструкции по делопроизводству в Центральной избирательной комиссии (утв. постановлением ЦИК России от 20.01.16 № 321/1831-6) есть такое определение: «докладная (служебная) записка — внутренний документ, адресованный вышестоящему должностному лицу от нижестоящего должностного лица и содержащий обстоятельное изложение какого-либо вопроса с выводами и предложениями составителя».

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

Правила составления служебных записок

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

Составить локальные акты по готовым шаблонам и подготовить всю кадровую отчетность

Важно

При составлении «служебок» желательно ориентироваться на общие правила делопроизводства, установленные в ГОСТ Р 7.0.97-2016 (далее — ГОСТ; утв. приказом Росстандарта от 08.12.16 № 2004-ст). В частности, стоит придерживаться общих требований к созданию документа (разд. 3 ГОСТ), а также правил оформления реквизитов (разд. 4 и 5 ГОСТ).

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

Как написать служебную записку

Сначала нужно указать адресат (или несколько адресатов) «служебки». Обычно таковыми являются должностные лица организации. Соответствующий реквизит принято проставлять в правой верхней части документа. При этом наименование должности указывается в дательном падеже (т.е. отвечает на вопрос «кому?» — директору, начальнику). А потом вносятся фамилия и инициалы получателя записки (п. 5.15 ГОСТ).

Затем по центру документа проставляется его наименование (п. 5.9 ГОСТ). А ниже можно разместить заголовок, отражающий краткое содержание «служебки» и дающий пояснение о том, на какую тему она составлена (п. 5.17 ГОСТ).

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

Важно

При обозначении адресата и в тексте «служебки» инициалы указываются после фамилии. А при расшифровке подписи — перед ней.

Обменивайтесь подлинниками документов с сотрудниками через интернет

Входящие бесплатно

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

И заключительный штрих — проставление даты (а при необходимости также и времени) подписания. Эти сведения располагаются под подписью. Указать дату можно одним из двух способов. Либо арабскими цифрами, разделенными точкой: 05.10.2021, либо словесно-цифровым способом: 5 октября 2021 г. (п. 4.10 Методических рекомендаций по применению ГОСТ Р 7.0.97-2016).

Внимание!

При указании даты цифрами, разделенными точками, первые два реквизита всегда содержат 2 цифры (т.е. 5 января надо указать как 05.01), а буква г. после указания года не проставляется. Если же дата указывается словесно-цифровым способом, то цифра 0 перед днем не используется (т.е. пишется 5 января, а не 05 января), а после указания года проставляется буква г.

Образец служебной записки

Бесплатно рассчитать зарплату и отпускные в веб‑сервисе

Бланки для скачивания

Срок хранения служебной записки

Время хранения «служебок» различается в зависимости от типа документа. Все сроки перечислены в Перечне, утвержденном приказом Росархива от 20.12.19 № 236. Для удобства использования мы свели их в таблицу.

Вид записки	Срок хранения	Номер статьи Перечня
Докладные записки по разработке проектов правил, инструкций, регламентов, стандартов, порядков, положений, классификаторов, рекомендаций, кодексов	До минования надобности	9
Докладные, служебные записки по выполнению поручений руководства организации	5 лет	17
Докладные записки к протоколам, постановлениям, решениям, стенограммам совещательных (коллегиальных), исполнительных органов организации, контрольных, ревизионных органов организации, совещаний у руководителя организации, собраний трудовых коллективов организации, общих собраний владельцев ценных бумаг, участников, пайщиков	Постоянно	18
Докладные записки к протоколам, постановлениям, решениям, стенограммам собраний структурных подразделений организации	5 лет
Докладные, служебные записки к проектам приказов, распоряжений	1 год	20
Докладные записки по разработке проектов уставов, положений	До минования надобности	35
Докладные, служебные записки структурных подразделений по основной (профильной) деятельности	5 лет	47
Докладные, служебные записки по подготовке и проведению заседаний коллегиальных органов организации, общих собраний. съездов, конгрессов, пленумов, конференций, «круглых столов», совещаний, торжественных приемов, встреч	3 года	48
Докладные записки о состоянии работы по рассмотрению обращений граждан	5 лет	153
Докладные, служебные записки об организации и результатах контроля исполнения документов	1 год после снятия с контроля	159
Докладные и служебные записки по использованию, обслуживанию и совершенствованию информационных систем и программного обеспечения	5 лет	186
Докладные записки о соблюдении финансовой дисциплины	5 лет	255
Докладные записки о формировании фондов организации и их расходовании	5 лет	256
Докладные записки о проведении проверок финансово-хозяйственной деятельности	5 лет	282
Докладные записки по первичным статистическим данным	3 года	336
Докладные, служебные записки о нарушении правил внутреннего трудового распорядка, служебного распорядка	1 год	382
Докладные, служебные записки о соблюдении дисциплины труда	3 года	383
Докладные записки о разрешении трудовых споров, в том числе коллективных, с участием посредника	1 год после принятия решения	390
Докладные записки о переводе работников на сокращенный рабочий день или сокращенную рабочую неделю	5 лет	392
Докладные записки о разработке норм выработки и расценок	1 год после утверждения разработанных норм	398
Докладные записки об обеспечении рабочих и служащих средствами индивидуальной защиты, смывающими и обезвреживающими средствами, молоком и другими равноценными пищевыми продуктами, лечебно-профилактическим питанием	3 года, а при отсутствии других документов о вредных и опасных условиях труда —50/75 лет (в зависимости от даты создания записки)	427
Докладные записки к приказам, распоряжениям по личному составу о приеме, переводе, перемещении, ротации, совмещении, совместительстве, увольнении, оплате труда, аттестации, повышении квалификации, изменении анкетно-биографических данных, отпусках по уходу за ребенком, отпусках без сохранения заработной платы	50 лет (для документов, созданных после 1 января 2003 года) или 75 лет (для документов, созданных раннее)	434
Докладные записки к приказам, распоряжениям по личному составу о ежегодно оплачиваемых отпусках, отпусках в связи с обучением, дежурствах, не связанных с основной (профильной) деятельностью; о служебных проверках; о направлении работников в командировку	5 лет
Докладные записки о дисциплинарных взысканиях	3 года
Докладные записки, связанные с применением дисциплинарных взысканий	3 года	454
Докладные, служебные, объяснительные записки комиссии по соблюдению требований к служебному поведению государственных и муниципальных служащих, урегулированию конфликта интересов	5 лет	469
Докладные записки о повышении квалификации, профессиональной переподготовке работников, о проведении независимой оценки квалификации	5 лет	491
Докладные и служебные записки о состоянии и проведении ремонтных, наладочных работ технических средств	5 лет	520
Докладные, служебные записки по вопросам охраны объектов культурного наследия, природоохранных зон	5 лет	535
Докладные записки о развитии средств связи и их эксплуатации	5 лет	564
Докладные, служебные записки о расследовании чрезвычайных происшествий при охране зданий, перевозке ценностей	5 лет	587
Докладные, служебные записки о выдаче, утрате удостоверений, пропусков, идентификационных карт	1 год	588
Докладные, служебные записки об обеспечении противопожарного, внутриобъектового, пропускного режимов организации	5 лет	611

Бесплатно заполнить и сдать СЗВ‑ТД через интернет

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

Как подавать служебную записку в электронном виде

Сразу скажем, что возможность использования электронных «служебок» лучше прописать в локальном нормативном акте организации. А при их составлении можно применять те же правила ГОСТ Р 7.0.97-2016, которые учитываются при написании записок от руки. Единственное отличие будет касаться подписания документа.

Служебная записка не относится к тем документам, для которых законодательством установлен конкретный вид электронной подписи. А значит, можно использовать любую предусмотренную законом ЭП (письмо Минфина от 26.02.21 № 03-03-06/1/13409; см. «Минфин: первичные документы можно заверить любым видом электронной подписи»).

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

В частности, ключом электронной подписи может быть сочетание идентификатора и пароля (письмо ФГБУ «ФКП Росреестра» от 27.06.14 № 13-0033/14).

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

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

Источник

ГОСТ 19.505-79

Группа Т55

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

Единая система программной документации

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

Требования к содержанию и оформлению

Unified system for program documentation. Operation’s guide. Requirements for contents and form of presentation

МКС 35.080

Дата введения 1980-01-01

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

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

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

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

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

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

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

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

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

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

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

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

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

2. СОДЕРЖАНИЕ РАЗДЕЛОВ

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

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

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

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

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

Источник

(по ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению)

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

==================================

Скачать пример оформления

A.B.00001-01 34 01 (Руководство оператора) (пример — .pdf)	514 137 b	Загрузить
A.B.00001-01 34 01 (Руководство оператора) (шаблон — .dot)	17 902 b	Загрузить

На верх

==================================

Рекомендуемая структура программного документа (по ГОСТ 19.505-79. ЕСПД)

Лист утверждения
Титульный лист
Аннотация
Содержание
Основная часть

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

Функциональное назначение программы
Эксплуатационное назначение программы
Состав функций

Функции (такой-то)

Функции (этакой)

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

Минимальный состав аппаратных средств
Минимальный состав программных средств
Требования к персоналу (пользователю)

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

Загрузка и запуск программы
Выполнение программы

Выполнение функции (такой-то)
Выполнение функции (этакой)

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

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

Сообщение (такое-то)
Сообщение (этакое)

Приложения (необязательны)
Регистрация изменений

На верх

==================================

<Предыдущий>
<Содержание>

Источник

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

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

Примерный
план написания руководства пользователя
в соответствии с ГОСТ 19.505-79 «Руководство
оператора» /2/:

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

2.
Структура программы (какие окна есть,
как между ними переключаться, структура
меню и назначение его элементов).

3.
Каким образом осуществляется ввод
данных.

4.
Какая информация выводится на экран.

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

При
необходимости можно указать: требуются
ли от пользователя какие-либо настройки,
если да, то какие; нужно ли использовать
дополнительное программное обеспечение
и т.п.

5. Оформление пояснительной записки

Оформление
пояснительной записки к курсовой работе
выполняется в соответствии правилами,
принятыми кафедрой «Программное
обеспечение» /3/.

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

При
описании литературного источника
необходимо указать /4,5/:

фамилии
и инициалы авторов,
название
книги или статьи,
место
издания,
издательство,
год
издания.

При
описании ссылки на сайт Интернета
указать:

адрес
сайта,
наименование
сайта.

В
приложениях
помещают вспомогательные или дополнительные
материалы, которые иллюстрируют текст
основной части работы ( таблицы, графики,
диаграммы, схемы, рисунки). В приложение
выносятся тексты программ и руководство
пользователя. Каждое приложение должно
начинаться с новой страницы с указанием
в правом верхнем углу слова «ПРИЛОЖЕНИЕ»
и иметь тематический заголовок. При
наличии в работе более одного приложения
они нумеруются арабскими цифрами. На
все представленные приложения должны
быть сделаны ссылки из текста.

6. Защита курсовой работы

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

По
результатам защиты курсовых работ
выставляется зачет с дифференцированной
оценкой по четырехбальной системе
(«отлично», «хорошо», «удовлетворительно»,
«неудовлетворительно»)

В
ходе защиты курсовой работы оцениваются:

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

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

Источник