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

ЕСПД
устанавливает требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ и программных документов.
распространяются на программы и программную документацию (ПД) для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
определяют основные термины, относящиеся к программным продуктам и документам.
ГОСТ 19.004-80. Единая система программной документации. Термины и определения
ГОСТ 19.101-77. Единая система программной документации. Виды программ и программных документов

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

ГОСТ 19781-90
Не ЕСПД
ПО
Составная часть АС и АПК
Должно входить в спецификацию комплекса, раздел:
Комплексы, если ПО удовлетворяет определению комплекса;
Прочие изделия, если ПО- самостоятельный и единственный компонент
Комплекты, если ПО – совокупность программных компонентов, имеющих общее эксплуатационное назначение вспомогательного характера, но не выполняющих взаимосвязанные функции

Виды программных документов(19.101)

Виды эксплуатационных документов (19.101)

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

Правила обозначения ПД по ГОСТ 19.103-77
Другие ПД

Стадии разработки по ГОСТ 19.102-77

Стадии разработки по ГОСТ 19.102-77

Стадии разработки по ГОСТ 19.102-77

Замечания
70 гг. прошлого века
Пользователь – специалист, ставящий задачу программистам и получающий результаты вычислений от пользователей
Оператор – специально обученный работе на ЭВМ человек
В настоящее время
Пользователь – непосредственно работающий на ПК человек
Несоответствие между содержанием «Руководства пользователя» и ожидаемым от него порядком действия пользователя ПК
ГОСТ 34.201-89

34.201-89 - Руководство пользователя
применительно к АС в является аналогом руководства по эксплуатации аппаратного изделия, то есть содержит сведения, необходимые для правильной работы АС и его ПО:
состав и содержание дистрибутивного носителя данных;
порядок загрузки данных и программ;
описание всех выполняемых функций, задач, процедур и т. п.

Рекомендации
При проектировании АПК и АС удобно вести параллельную разработку аппаратной и программной частей по правилам ЕСКД и КСАС с учетом специфики, накладываемой требованиями ЕСПД.
Целесообразно для ПО АПК не разрабатывать ни руководство оператора, ни руководство пользователя, а порядок работы с ПО излагать в руководстве по эксплуатации комплекса, используя рекомендации по построению руководства пользователя АС.

Части ПД
Титульная (19.104-78)
Лист утверждения
Титульный лист
Информационная
Аннотация – сведения о назначении документа и краткое изложение его основной части
Содержание – перечень записей о структурных элементах(обозначение, наименование, адрес на носителе данных)
Основная (состав и структура по ЕСПД)
Регистрация изменений (ГОСТ 19.603-78)

Спецификация (19.202-78)
Форма спецификации приведена в обязательном приложении к стандарту.
Наименование каждого раздела указывают в виде заголовка в графе «Наименование». Для документов, выполненных печатным способом, заголовок подчёркивают.
Спецификация является основным программным документом для компонентов, применяемых самостоятельно, и для комплексов.
Информационную часть (аннотацию и содержание) допускается в документ не включать.
Спецификация в общем случае должна содержать разделы:
документация;
комплексы;
компоненты.

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

Спецификация (19.202-78). Раздел «Документация»

Спецификация (19.202-78). Разделы «Комплексы» и «Компоненты»

Текст программы (19.401-78)
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотация и содержание) является необязательным. Для текста программы на исходном языке при наличии аннотации в нее включают краткое описание функций программы.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
Допускается вводить наименования также и для совокупности разделов.
Каждый из разделов реализуется одним из типов символической записи, например:
символическая запись на исходном языке;
символическая запись на промежуточных языках;
символическое представление машинных кодов и т.п.
В символическую запись разделов рекомендуется включать комментарии, которые могут отражать, например, функциональное назначение, структуру.

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

Описание программы (19.402-78)
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
Описание программы должно содержать следующие разделы:
общие сведения;
функциональное назначение;
описание логической структуры;
используемые технические средства;
вызов и загрузка;
входные данные;
выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.

Описание программы (19.402-78). Продолжение
В разделе «Общие сведения» должны быть указаны:
обозначение и наименование программы;
программное обеспечение, необходимое для функционирование программы;
языки программирования, на которых написана программа.
В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
В разделе «Описание логической структуры» должны быть указаны:
алгоритм программы;
используемые методы;
структура программы с описанием функций составных частей и связи между ними;
связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.

Описание программы (19.402-78). Продолжение
В разделе «Используемые технические средства» должны быть указаны типы электронно-вычислительных машин и устройств, которые используются при работе программы.
В разделе «Вызов и загрузка» должны быть указаны:
способ вызова программы с соответствующего носителя данных;
входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
В разделе «Входные данные» должны быть указаны:
характер, организация и предварительная подготовка входных данных;
формат, описание и способ кодирования входных данных.
В разделе «Выходные данные» должны быть указаны:
характер и организация выходных данных;
формат, описание и способ кодирования выходных данных.

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

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

Руководство системного программиста (ГОСТ 19.503-79)
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
Руководство системного программиста должно содержать следующие разделы:
общие сведения о программе;
структура программы;
настройка программы;
проверка программы;
дополнительные возможности;
сообщения системному программисту.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы».

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

Руководство оператора (ГОСТ 19. 505 – 79)
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
Руководство оператора должно содержать следующие разделы:
назначение программы;
условия выполнения программы;
выполнение программы;
сообщения оператору.
Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

Руководство оператора. Содержание разделов