Руководство
программиста должно содержать разделы:
-
Назначение и
условия применения программы. -
Характеристики
программы. -
Обращение к
программе. -
Входные и выходные
данные. -
Сообщения.
При описании
назначения
и условий применения программы необходимо
указать назначение и функции, выполняемые
программой; условия, необходимые для
выполнения программы: объем оперативной
памяти, требования к составу и параметрам
периферийных устройств; требования к
ПО и т.д.
В
разделе Характеристики
программы необходимо
привести описание
основных характеристик и особенностей
программы: временных
характеристик, режима работы, средств
контроля правильности
выполнения и самовосстанавливаемости
программы и т.д.
Раздел
Обращение
к программе представляет
собой описание процедур
вызова программы (способов передачи
управления и параметров данных и др.).
Раздел
Входные
и выходные данные должен
содержать описание
организации используемой входной и
выходной информации и при необходимости
ее кодирования.
При описании
сообщений
необходимо
привести тексты сообщений, выдаваемых
программисту или оператору в ходе
выполнения программы, описание их
содержания и действия, которые необходимо
предпринять по этим сообщениям.
Гост 19.505-79 еспд. Руководство оператора. Требования к содержанию и оформлению
Руководство
оператора должно включать:
-
Назначение
программы. -
Условия выполнения
программы. -
Выполнение
программы. -
Сообщения оператору.
При
описании назначений
программы необходимо
указать сведения
о назначении программы и информацию,
достаточную для понимания функций
программы и ее эксплуатации.
Условия выполнения
программы должны
содержать условия, необходимые для
выполнения программы: минимальный и/или
максимальный состав аппаратурных и
программных средств.
В
разделе
Выполнение
программы необходимо
указать последовательность
действий оператора, обеспечивающих
загрузку, запуск, выполнение и завершение
программы; привести описание функций,
формата и возможных вариантов команд,
с помощью которых оператор осуществляет
загрузку и управляет выполнением
программы, а также ответы программы на
эти команды.
При описании
сообщений
оператору приводят
тексты сообщений, выдаваемых в ходе
выполнения программы, описание их
содержания и соответствующие действия
оператора: действия в случае сбоя,
возможности повторного запуска программы
и т.д.
Гост 19.506-79 еспд. Описание языка. Требования к содержанию и оформлению
При описании языка
необходимо указать:
-
Общие сведения.
-
Элементы языка.
Кроме того,
допускается вводить дополнительные
разделы.
-
Способы
структурирования программы. -
Средства обмена
данными. -
Встроенные
элементы. -
Средства отладки
программы.
Общие сведения
должны
содержать назначение и описание общих
характеристик языка, его возможностей,
основных областей применения и др.
В разделе Элементы
языка приводят
описание синтаксиса и семантики базовых
и составных элементов языка.
Раздел
Способы
структурирования программы должен
описывать способы вызова процедур
передачи управления и другие элементы
структурирования программы.
Раздел
Средства
обмена данными должен
содержать описание языковых
средств обмена данными (например, средств
ввода-вывода,
средств внутреннего обмена данными и
т.д.).
В разделе Встроенные
элементы описываются
встроенные в
язык элементы: функции, классы и т.д. и
правила их использования.
При
описании средств
отладки необходимо
привести
описание имеющихся в языке средств
отладки программ, семантики этих средств,
дать рекомендации по их применению.
ГОСТ
Р ИСО/МЭК 9294-93. Информационная технология.
Руководство
по управлению документированием
программного обеспечения.
Стандарт
полностью соответствует международному
стандарту ИСО/МЭК 9294:1990 и устанавливает
рекомендации по эффективному управлению
документированием ПС для руководителей,
отвечающих за их создание. Целью стандарта
является оказание помощи в определении
стратегии документирования ПС; выборе
стандартов по документированию; выборе
процедур документирования; определении
необходимых ресурсов; составлении
планов документирования.
ГОСТ
Р ИСО/МЭК 9126-93. Информационная технология.
Оценка
программной продукции. Характеристики
качества и руководства
по их применению. Стандарт
полностью соответствует международному
стандарту ИСО/МЭК 9126:1991. В его контексте
под характеристикой качества понимается
«набор свойств (атрибутов) программной
продукции, по которым ее качество
описывается и оценивается». Стандарт
определяет шесть комплексных
характеристик, которые с минимальным
дублированием описывают
качество ПС (ПО, программной продукции):
-
функциональные
возможности; -
надежность;
-
практичность;
-
эффективность;
-
сопровождаемость;
-
мобильность.
Эти характеристики
образуют основу для дальнейшего уточнения
и описания качества ПС.
ГОСТ
Р ИСО 9127-94. Системы обработки информации.
Документация
пользователя и информация на упаковке
для потребительских
программных пакетов. Стандарт
полностью соответствует
международному стандарту ИСО 9127:1989. В
контексте настоящего стандарта под
потребительским программным пакетом
(ПП) понимается «программная продукция,
спроектированная и продаваемая для
выполнения определенных функций;
программа и соответствующая ей
документация, упакованные для продажи
как единое целое». Под документацией
пользователя понимается документация,
которая обеспечивает конечного
пользователя информацией по установке
и эксплуатации ПП. Под информацией на
упаковке понимают информацию,
воспроизводимую на внешней
упаковке ПП. Ее целью является
предоставление потенциальным
покупателям первичных сведений о ПП.
ГОСТ
Р ИСО/МЭК 8631-94. Информационная технология.
Программные
конструктивы и условные обозначения
для их представления.
Описывает
представление процедурных алгоритмов.
Как
уже говорилось, пока нет лучшего, можно
извлекать пользу и
из тех стандартов ЕСПД, которые приняты
еще около 20 лет назад. Но всем ясно, что
ориентироваться надо на современные
стандарты.
Практики используют
еще один путь: сами переводят и используют
в своих проектах современные стандарты
на организацию ЖЦ ПС и их документирование.
Но этот путь страдает как минимум
тем недостатком, что разные переводы и
адаптации стандартов,
сделанные разными разработчиками и
заказчиками, будут отличаться массой
деталей. Эти отличия неизбежно касаются
не только наименований, но и их
содержательных определений, вводимых
и используемых в стандартах. Таким
образом, на этом пути неизбежно постоянное
возникновение путаницы, а это прямо
противоположно целям не только стандартов,
но и любых грамотных методических
документов [59].
ГОСТ
Р ИСО/МЭК 12119:1994. Информационная технология.
Пакеты
программных средств. Требования к
качеству
и испытания. В
этом стандарте установлены требования
к качеству пакетов программ и инструкции
по их испытаниям
на соответствие заданным требованиям.
Понятие «пакет программных средств»
фактически отождествляется
с более общим понятием «программный
продукт», рассматриваемым
как совокупность программ, процедур и
правил, поставляемых
нескольким пользователям для общего
применения или
функционирования. Каждый пакет программ
должен иметь описание
продукта и пользовательскую документацию.
Рассмотрим более
подробно содержание данного стандарта.
Стандарт определяет
требования к описанию
продукта, к
пользовательской
документации, программам и данным,
входящим
в пакет
программ, и испытаниям пакетов программ.
Предполагается,
что документ «Описание продукта» должен
помочь пользователю или потенциальному
покупателю в оценке того, подходит ли
для них данный продукт, а пользовательская
документация
должна содержать всю информацию,
необходимую для
применения продукта.
В контексте данного
стандарта требования к качеству продукта
рассматриваются с точки зрения описания
реальных свойств продукта
в «Описании продукта» и пользовательской
документации. Требования к программам
и данным в основном сводятся к утверждению
необходимости соответствия реальных
свойств продукта
свойствам, объявленным в документации.
В связи с этим документ
формально не может рассматриваться как
стандарт требований. Несмотря на эту
ограниченность, стандарт может оказаться
весьма полезным при определении исходных
требований к продукту:
-
требования,
согласно которому каждый пакет программ
должен содержать
описание продукта и документацию
пользователя; -
требования
к описанию продукта. В частности,
требования, согласно
которому описание продукта должно
содержать конкретную информацию, а все
приводимые в нем формулировки должны
быть проверяемыми (контролируемыми) и
корректными; -
требования к
документации пользователя; -
требования к любым
программам и данным, входящим в состав
пакета программ.
Описание
продукта. Описание
продукта (product
description):
документ,
определяющий свойства пакета программ,
основным назначением которого является
оказание помощи потенциальным покупателям
в оценке пригодности для них данного
продукта до его приобретения.
Каждый
пакет
программ должен содержать описание
продукта.
Оно должно являться частью документации
пакета для данного
продукта и содержать информацию по
документации пользователя,
программам и соответствующим данным.
Основным назначением
описания продукта является помощь
пользователю и потенциальному покупателю
при оценке ими пригодности продукта
для их нужд. Для обеспечения этого
описание продукта также должно содержать
соответствующую торговую информацию.
Описывая любой
программный продукт, необходимо
придерживаться
установленных требований к содержанию.
В связи с этим можно
выстроить определенную иерархию
материала, подлежащего описанию:
-
Общие требования
к содержанию. -
Обозначения и
указания. -
Функциональные
возможности. -
Надежность.
-
Практичность.
-
Эффективность.
-
Сопровождаемость
и мобильность.
Описание продукта
должно быть доступным для человека,
заинтересованного в данном продукте,
и удовлетворять общим
требованиям к содержанию:
-
быть достаточно
понятным, полным и простым при изучении,
чтобы обеспечить помощь потенциальным
покупателям при оценке ими пригодности
данного продукта для их нужд до его
покупки; -
быть внутренне
непротиворечивым. Каждый термин должен
иметь один и тот же смысл по всему
документу; -
формулировки
должны быть проверяемыми и корректными.
При описании
продукта необходимо приводить следующие
указания
и
обозначения:
-
При обозначении
одного или нескольких продуктов в
рамках одного пакета необходимо хотя
бы включать наименование продукта и
обозначение его версии или даты выпуска.
-
Должны быть
включены наименование и адрес поставщика.
-
Должны быть
определены целевые рабочие задачи,
которые могут быть выполнены данным
продуктом. -
Из описания
продукта могут быть даны ссылки на
нормативные документы, которым
удовлетворяет данный продукт, в этом
случае должны быть указаны соответствующие
редакции данных документов.
5. Должна
быть определена система (технические
и программные
средства и их конфигурация), необходимая
для ввода продукта
в эксплуатацию, включая наименования
изготовителейи обозначения типов всех
ее частей, например:
-
процессоры, включая
сопроцессоры; -
объем основной
(оперативной) памяти; -
типы и объемы
(памяти) периферийных запоминающих
устройств; -
расширяющие платы;
-
оборудование
ввода и вывода; -
сетевое оборудование;
-
системные и прочие
программные средства.
-
Должны
быть определены соответствующие
интерфейсы или продукты,
если в описании продукта имеются ссылки
на интерфейсы с другими продуктами. -
Должен быть
определен каждый физический компонент
поставляемого продукта, в частности,
все печатные документы и все носители
данных. -
Должен
быть установлен вид поставляемых
программ, например
исходные программы, объектные (рабочие)
модули или загрузочные модули. -
Должно быть
указано, будет ли инсталляция продукта
проводиться пользователем или нет. -
Должно быть
указано, будет или не будет предлагаться
поддержка при эксплуатации продукта. -
Должно быть
указано, будет или не будет предлагаться
сопровождение продукта. Если сопровождение
предусматривается, то должно быть
установлено, что оно подразумевает.
При описании
функциональных
возможностей необходимо
отразить:
1.
Обзор
функций.
В описании продукта
должен быть приведен обзор функций
продукта,
вызываемых пользователем, необходимых
для них данных
и предоставляемых средств. Для каждой
функции (особенно для ее опции или
варианта) должно быть четко установлено,
является ли она частью:
• продукта;
-
расширения
продукта, полностью приведенного в
описании продукта; -
расширения
продукта, на которое дана ссылка в
описании продукта; -
негарантируемого
(необязательного) приложения.
2. Граничные
значения.
Если использование
продукта ограничено конкретными
граничными значениями для продукта,
они должны быть указаны в описании
продукта. Например:
-
минимальные или
максимальные значения; -
длины ключей;
-
максимальное
число записей в файле; -
максимальное
число критериев поиска; -
минимальный объем
выборки.
В случае, когда
невозможно определить фиксированные
граничные значения (например, когда они
зависят от типа приложения или от
исходных данных), на них должны быть
наложены соответствующие ограничения.
Могут быть приведены допустимые
комбинации значений и даны ссылки на
более конкретную информацию из
документации пользователя.
Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #
- Из стандартов
- ЕСПД
ГОСТ 19.504-79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению. Unified system for program documentation. Programmer’s guide. Requirements for contents and form of presentation. МКС 35.080. Редакция от 12.02.2023.
1 Общие положения ГОСТ 19.504-79
⇪В 22856 💥
⇪В 22846 💥
1.1 Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным [из 1.1 ГОСТ 19.504-79]
- Открыть в новой вкладке
⇪В 22846 💥
1.2 Руководство программиста должно содержать следующие разделы:
- назначение и условия применения программы (1);
- характеристика программы (2);
- обращение к программе (3);
- входные и выходные данные (4);
- сообщения (5).
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые [из 1.2 ГОСТ 19.504-79]
- Открыть в новой вкладке
- Открыть в новой вкладке
2 Содержание разделов ГОСТ 19.504-79
⇪В 22856 💥
⇪В 22849 💥
2.1 В разделе «Назначение и условия применения программы» должны быть указаны назначение (1.1) и функции, выполняемые программой (1.2), условия, необходимые для выполнения программы (1.3) (объем оперативной памяти (1.3.1), требования к составу и параметрам периферийных устройств (1.3.2), требования к программному обеспечению (1.3.3) и т.п.) [из 2.1 ГОСТ 19.504-79]
- Открыть в новой вкладке
⇪В 22849 💥
2.2 В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (2.1) (временные характеристики (2.1.1), режим работы (2.1.2), средства контроля правильности выполнения и самовосстанавливаемости программы (2.1.3) и т.п.) [из 2.2 ГОСТ 19.504-79]
- Открыть в новой вкладке
⇪В 22849 💥
2.3 В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (3.1) (способы передачи управления (3.2) и параметров данных (3.3) и др.) [из 2.3 ГОСТ 19.504-79]
- Открыть в новой вкладке
⇪В 22849 💥
2.4 В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной (4.1) и выходной информации (4.2) и, при необходимости, ее кодирования (4.3) и (4.4) [из 2.4 ГОСТ 19.504-79]
- Открыть в новой вкладке
⇪В 22849 💥
2.5 В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы (5.1), описание их содержания (5.2) и действий, которые необходимо предпринять по этим сообщениям (5.3) [из 2.5 ГОСТ 19.504-79]
- Открыть в новой вкладке
⇪В 22849 💥
2.6 В приложении (6) к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из 2.6 ГОСТ 19.504-79]
- Открыть в новой вкладке
- Открыть в новой вкладке
- Из ГОСТ 19.504-79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению
Требования к структуре руководства программиста по ГОСТ 19 устанавливаются ГОСТ 19.504. В общем случае документ должен состоять из следующих разделов:
1. Назначение и условия применения программы
2. Характеристики программы
3. Обращение к программе
4. Входные и выходные данные
5. Сообщения
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
Примечание
Эти и другие требования к структуре и содержанию руководства программиста по ГОСТ 19 подробнее см. ГОСТ 19.504
Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).
(по ГОСТ 19.504-79. ЕСПД. Руководство программиста. Требования к содержанию и оформлению)
Настоящий стандарт устанавливает требования к
содержанию и оформлению программного документа «Руководство программиста», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в
соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и
содержания) является обязательным.
==================================
Скачать пример оформления
A.B.00001-01 33 01 (Руководство программиста) (пример — .pdf) |
563 164 b | Загрузить |
A.B.00001-01 33 01 (Руководство программиста) (шаблон — .dot) |
20 002 b | Загрузить |
На верх
==================================
Рекомендуемая структура программного документа (по ГОСТ 19.504-79. ЕСПД)
- Лист утверждения
- Титульный лист
- Аннотация
- Содержание
- Основная часть
- Назначение и условия применения программ
- Назначение программы
- Функции, выполняемые программой
- Условия, необходимые для выполнения программы
- Объем оперативной памяти
- Требования к составу периферийных устройств
- Требования к параметрам периферийных устройств
- Требования к программного обеспечению
- Требования к персоналу (программисту)
- Характеристика программы
- Описание основных характеристик программы
- Временные характеристики программы
- Режим работы программы
- Средства контроля правильности выполнения программы
- Описание основных особенностей программы
- Самовосстанавливаемость программы
- Обращение к программе
- Загрузка и запуск программы
-
Выполнение программы
- Выполнение функции (такой-то)
- Выполнение функции (этакой)
- Завершение работы программы
- Входные и выходные данные
- Организации используемой входной информации
- Организации используемой выходной информации
- Сообщения
- Сообщение (такое-то)
- Сообщение (этакое)
- Приложения (необязательны)
- Регистрация изменений
На верх
==================================
<Предыдущий>
<Содержание> <Следующий>
643.02069436.41NNN-01
33 01-1
«Шифрование
данных»
Программа
Руководство программиста
643.02069436.41NNN—01
33 01-1
Листов 6
АННОТАЦИЯ
Приводится руководство
программиста программы «Шифрование
данных».
Программа предназначена
для шифрования и дешифрования данных,
с применением алгоритма шифрования
«Шифр-Гост 28147-89».
Ограничения программы: программа
аварийно завершается при загрузке
файлов с размером более 500 МБ.
Условия эксплуатации программы:
возможность применения в локальной
сети;
на персональных компьютерах
с процессором не ниже 300МГц, минимум
оперативной памяти 16 MБ и операционная
система не ниже Windows 95.
Распространяется на дискетах.
Рассматриваются
общие сведения о программе, структура
программы, настройка программы, проверка
программы, дополнительные возможности
программы, сообщения программисту.
СОДЕРЖАНИЕ
стр.
1 Назначение и условия применения
программы 4
1.1 Назначение программы 4
1.2 Функции программы 4
Функция открытия и чтения файла
“LoadFile” вызывается путем нажатия
Файл->Открыть и загрузка данных из
файла при выборе файла в диалоговом
окне. 4
1.4 Требования к программному обеспечению 4
2 Характеристики программы 4
2.1 Средства проверки правильности
выполнения программы 4
2.2 Функционирование программы после
сбоев 4
3 Обращение к программе 4
3.1 Способы вызова программы с различных
носителей данных 4
3.2 Входные точки в программу 4
3.3 Способы передачи управления и
параметров данных 4
3.4 Обращение к программе – приложению 5
4 Входные и выходные данные 5
4.1 Формат, характер и организация входных
данных 5
4.2 Формат, характер и организация
выходных данных 5
5 Сообщения 5
5.1 Сообщения программисту и действия
по ним 5
6 Дополнительные материалы 5
6.1 Примеры 5
Производится открытие файлов путем
нажатия Файл->Открыть и загрузка
данных из файла при выборе файла в
диалоговом окне. 5
6.2 Иллюстрации 6
Окно ввода (отображения) Ключ Окно
вывода (отображения) 6
Главное меню Строка состояния процесса 6
1 Назначение и условия применения
программы
1.1 Назначение программы
Описываемая программа предназначена
для шифрования и дешифрования
данных, хранящихся в файлах.
1.2 Функции программы
-
Функция
открытия и чтения файла “LoadFile”
вызывается путем нажатия
Файл->Открыть и
загрузка данных из файла при выборе
файла в диалоговом окне.
-
При нажатии Шифрование->Зашифровать
программа вызывает процедуру “Coding”,
которая зашифровывает данные и выводит
результат в окно для ввода текста. -
При выборе в меню
Шифрование->Расшифровать
– программа вызывает процедуру
“Recoding”,
которая расшифровывает данные с выводом
в результата в текстовое окно. -
Запись данных в файл
происходит путем нажатия Файл->Сохранить
— вызове функции
“SaveFile”и
выборе в диалоговом окне документа для
записи данных.
1.3 Использование оперативной памяти
Количество необходимой оперативной
памяти определяется размером обрабатываемых
данных, плюс к этому 1 МБ для загрузки
самой программы и создания всех
необходимых переменных и структур.
1.4 Требования к программному обеспечению
Операционная система Windows95
и выше.
2.1 Средства проверки правильности
выполнения программы
Правильность работы программы можно
проверить только лишь экспериментально.
Наилучший способ, моделирование реальной
работы, с контролем полученных результатов.
2.2 Функционирование программы после
сбоев
После сбоя достаточно перезапустить
программный продукт. Никаких дополнительных
действий производить не требуется.
3.1 Способы вызова программы с различных
носителей данных
Программа может вызываться с любых
носителей.
3.2 Входные точки в программу
Исполняемым файлом программы является
файл «CodingGost.exe«.
3.3 Способы передачи управления и
параметров данных
Передача параметров производится в
режиме диалога программы с пользователем.
3.4 Обращение к программе – приложению
С помощью программ файл — менеджеров
зайти в каталог, в который установлена
программа и запустить файл «CodingGost.exe».
4.1 Формат, характер и организация входных
данных
Загрузка данных в виде текста или файла
любого формата для (рас)зашифровывания.
4.2 Формат, характер и организация выходных
данных
Cохранение (рас)зашифрованных
данных в файл любого формата, либо
простым отражением в текстовом поле.
5.1 Сообщения программисту и действия
по ним
№ п/п |
Сообщение |
Описание |
Действия |
1 |
2 |
3 |
4 |
1. |
“Отсутствуют |
Системное окно |
Загрузить файл. |
2. |
“Не задан ключ!” |
Системное окно |
Ввести ключ для |
6.1 Примеры
Производится
открытие файлов путем
нажатия Файл->Открыть и
загрузка данных из файла при выборе
файла в диалоговом окне.
Возможен ввод текста для шифрования в
окно и его загрузка из него.
При нажатии Шифрование->Зашифровать
программа зашифровывает данные и выводит
результат в окно для ввода текста.
При выборе в меню Шифрование->Расшифровать
– происходит расшифровка данных с
выводом в результата в текстовое окно.
Запись данных в файл происходит путем
нажатия Файл->Сохранить и выборе
в диалоговом окне документа для записи
данных.
Можно изменить параметры шифрования –
ключ шифрования, “S
— блоки”.
6.2 Иллюстрации
Основная форма
Окно ввода
(отображения) Ключ Окно
вывода (отображения)
Главное меню
Строка состояния
процесса