Требования к структуре руководства программиста по ГОСТ 19 устанавливаются ГОСТ 19.504. В общем случае документ должен состоять из следующих разделов:
1. Назначение и условия применения программы
2. Характеристики программы
3. Обращение к программе
4. Входные и выходные данные
5. Сообщения
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
Примечание
Эти и другие требования к структуре и содержанию руководства программиста по ГОСТ 19 подробнее см. ГОСТ 19.504
Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).
(по ГОСТ 19.504-79. ЕСПД. Руководство программиста. Требования к содержанию и оформлению)
Настоящий стандарт устанавливает требования к
содержанию и оформлению программного документа «Руководство программиста», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в
Как стать программистом с нуля
соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и
содержания) является обязательным.
Скачать пример оформления
Рекомендуемая структура программного документа (по ГОСТ 19.504-79. ЕСПД)
- Лист утверждения
- Титульный лист
- Аннотация
- На верх ==================================
- Документы
- Программные
Документ предназначен для участников команды проекта, осуществляющих разработку ПК «Интероперабельность», а также персонала ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация», ответственного за эксплуатацию ПК «Интероперабельность» в части использования по назначению.
- Открыть в новой вкладке
Документ разработан согласно ГОСТ 19.504-79, структура и оформление документа соответствуют ГОСТ 19.105-78, основные надписи титульной части — по ГОСТ 19.104-78, выполнен печатным способом согласно ГОСТ 19.106-78.
- Открыть в новой вкладке
- Открыть в новой вкладке
Основная часть документа содержит сведения о назначении, условиях применения, характеристиках ПК «Интероперабельность», способы обращения к ПК «Интероперабельность», сведения о входных и выходных данных, а также сообщения ПК «Интероперабельность».
- Открыть в новой вкладке
- 33 — РУКОВОДСТВО ПРОГРАММИСТА по ГОСТ 19.504-79
- Руководство ☠ Программист ☠ Пример ☠ Образец
Руководство
программиста должно содержать разделы:
- Назначение и
условия применения программы. - Характеристики
программы.
При описании
назначения
и условий применения программы необходимо
указать назначение и функции, выполняемые
программой; условия, необходимые для
выполнения программы: объем оперативной
памяти, требования к составу и параметрам
периферийных устройств; требования к
Как люди представляют программиста, и как он выглядит на самом деле!
ПО и т.д.
В
разделе Характеристики
программы необходимо
привести описание
основных характеристик и особенностей
программы: временных
характеристик, режима работы, средств
контроля правильности
выполнения и самовосстанавливаемости
программы и т.д.
Раздел
Обращение
к программе представляет
собой описание процедур
вызова программы (способов передачи
управления и параметров данных и др.).
Раздел
Входные
и выходные данные должен
содержать описание
организации используемой входной и
выходной информации и при необходимости
ее кодирования.
При описании
сообщений
необходимо
привести тексты сообщений, выдаваемых
программисту или оператору в ходе
выполнения программы, описание их
содержания и действия, которые необходимо
предпринять по этим сообщениям.
Гост 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. Граничные
значения.
Если использование
продукта ограничено конкретными
граничными значениями для продукта,
они должны быть указаны в описании
продукта. Например:
- минимальные или
максимальные значения; - длины ключей;
- максимальное
число записей в файле; - максимальное
число критериев поиска;
В случае, когда
невозможно определить фиксированные
граничные значения (например, когда они
зависят от типа приложения или от
исходных данных), на них должны быть
наложены соответствующие ограничения.
Могут быть приведены допустимые
комбинации значений и даны ссылки на
более конкретную информацию из
документации пользователя.
Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]
Источник: instrukciya24.ru
Руководство программиста
Документация принадлежит к типу программной и эксплуатационной. Объединяет в себе пакеты документов программы, комплекса и его программных компонентов. Создается для программистов-создателей программы и тех программистов, работающих с данным программным продуктом или разрабатывающих новые продукты на базе данного.
Целью документации является предоставление программистам возможностей для решения задач, поставленных для данной программы. Все документы соответствуют стандартам: ГОСТ 19.504-79.
Предмет и применение
Руководство для программистов разрабатывается если:
1. Создаваемая программа предназначена для области разработки или библиотеки.
2. Создаваемая программа становится основой для разработки программ и систем конкретного вида.
3. Распространение программного продукта происходит вместе с исходным кодом или она нуждается в постоянной модификации.
Бывают и другие случаи, требующие разработки руководства для программиста, но они являются единичными.
Основной целью руководства является обеспечение программиста-разработчика сведениями для написания собственной программы на базе данной.
Содержание
— Устройство и конструкция программы: ее части, местоположение, время существования, взаимодействие.
— Перечень требуемых средств разработки для описания приложения (системы).
— Область действия приложения (системы), требования к ней, дополняющие программные средства.
— Работоспособность системы (приложения), последовательность создания необходимых объектов и принцип их взаимодействия.
— Пошаговое разворачивание действующей системы (приложения).
Также руководство для программиста дополняется описанием нужных в данной программе объектов. В случае использования в данной программе оригинального языка, необходимо включить и его описание.
Методология и язык написания
Главное — логичность и порядок изложения. Необходимо, чтобы текст соответствовал следующим правилам:
— Появление нового определения должно базироваться на уже известных ранее;
— Появление всех понятий должно быть целесообразным и обоснованным.
При описании отдельных объектов главное внимание уделяется:
— описание всего, что происходит до создания и применения объекта;
— способы восприятия объектом поступаемых сведений;
— местоположение объекта.
Описание всех объектов чаще всего объединяют в «Справочник программиста».
Стандартная структура — согласно ГОСТ 19.504-79.
1. Назначение и условия применения программы.
2. Характеристика программы.
3. Обращение к программе.
4. Входные и выходные данные.
5. Сообщения.
Источник: tehpis.ru
курсовая. Курсовая Бойков И.Р.. Руководство программисту 12 Руководство оператору 13 Выводы по работе 14 Список литературы 15
Единственный в мире Музей Смайликов
Самая яркая достопримечательность Крыма
Скачать 85.1 Kb.
Оглавление
1 Разработка и анализ технического задания 3
2 Разработка программы 5
Листинг программы 9
Руководство программисту 12
Руководство оператору 13
Выводы по работе 14
Список литературы 15
1 Разработка и анализ технического задания
Каждый год, число абитуриентов растет. Становится все сложнее вести учет абитуриентов и проводить отбор для поступления.
Программа позволит пользователю вести учет списка абитуриентов, а также просматривать его с различным типом упорядочивания.
Основания для разработки
Учебный план изучения дисциплины «Технология разработки программных продуктов».
Назначение
- Требования к функциональным характеристикам;
- Требования к надежности;
- Требования к составу и параметрам технических средств;
Минимальные системные требования:
а) Процессор: 1 ГГц или выше;
- Требования к информационной и программной совместимости;
Должны быть разработаны следующие эксплуатационные документы:
а) Инструкция для пользователя;
б) Справка о программе;
2 Разработка программы
- char * InputStr() – функция ввода строки с пробелами.
- int InputInt(const char * str, int a, int b) – функция ввода целого числа с проверкой корректности ввода и допустимости диапазона.
- Student InputStudent() – ввод данных о студенте.
- void PrintStudent(Student b) – вывод данных о студенте.
- void Save(vector list, const char * path) – сохранение списка в файл.
- vector Open(const char * path) – Чтение списка из файла.
- void PrintList(vector list) – печать списка.
Ниже приведены таблицы идентификаторов разработанных функций.
Таблица 1 – Описание идентификаторов функции InputStr
| Наименование | Тип | Назначение |
| str | char * | Вводимая строка |
Таблица 2 – Описание идентификаторов функции InputStudent
| Наименование | Тип | Назначение |
| b | Student | Вводимые данные о абитуриенте |
Таблица 3 – Описание идентификаторов функции PrintStudent
| Наименование | Тип | Назначение |
| b | Student | Выводимые данные о студенте |
Таблица 4 – Описание идентификаторов функции InputInt
| Наименование | Тип | Назначение |
| str | char * | Выводимая строка |
| a | int | Левая граница интервала |
| b | int | Правая граница интервала |
| num | char * | Вводимое строковое значение пользователем |
| size | int | Длина вводимого значения |
| n | int | Числовое представление значения |
Таблица 5 – Описание идентификаторов функции Save
| Наименование | Тип | Назначение |
| tf | FILE | Файловый поток для сохранения |
| path | char * | Путь к файлу, для сохранения списка |
| list | vector | Список абитуриентов |
Таблица 6 – Описание идентификаторов функции Open
| Наименование | Тип | Назначение |
| tf | FILE | Файловый поток для чтения |
| path | char * | Путь к файлу, для чтения списка |
| list | vector | Список абитуриентов |
| sp | Enrollee | Читаемый из файла абитуриент |
Таблица 5 – Описание идентификаторов функции main
| Наименование | Тип | Назначение |
| a | int | Поле для выбора пункта меню |
| list | vector | Список абитуриентов |
Алгоритм решения задачи
Ниже приведены блок-схемы основных функций.
Рисунок 1 – Блок-схемы функции main
Рисунок 2 – Блок-схемы функции Open
Рисунок 3 – Блок-схемы функции Save
Источник: topuch.com