Единая система программной документации (ЕСПД) — комплекс государственных стандартов Российской Федерации, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации.
В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность: унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках; снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий; автоматизации изготовления и хранения программной документации. Сопровождение программы включает анализ функционирования, развитие и совершенствование программы, а также внесение изменений в нее с целью устранения ошибок.
Правила и положения, установленные в стандартах ЕСПД, распространяются на программы и программную документацию для вычислительных машин, комплексов и систем независимо от их назначения и области применения. В состав ЕСПД входят: основополагающие и организационно-методические стандарты; стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных; стандарты, обеспечивающие автоматизацию разработки программных документов. Разработка организационно-методической документации, определяющей и регламентирующей деятельность организаций по разработке, сопровождению и эксплуатации программ, должна проводиться на основе стандартов ЕСПД.
Стандарты ЕСПД подразделяют на группы, приведенные в таблице
Обозначения стандартов ЕСПД строят по классификационному признаку. Обозначение стандарта ЕСПД должно состоять из: цифр 19, присвоенных классу стандартов ЕСПД; одной цифры (после точки), обозначающей код классификационной группы стандартов, указанной в п. 3.1; двузначного числа, определяющего порядковый номер стандарта в группе; двузначного числа (после тире), указывающего год регистрации стандарта.
Пример обозначения стандарта «Единая система программной документации. Общие положения».
ГОСТ 19.001-77. ЕСПД. Общие положения. ГОСТ 19.003-80. ЕСПД. Схемы алгоритмов и программ. Обозначения условные графические. - Заменен на ГОСТ 19.701-90 ГОСТ 19.005-85. ЕСПД. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения. ГОСТ 19.101-77. ЕСПД. Виды программ и программных документов. ГОСТ 19.102-77. ЕСПД. Стадии разработки. ГОСТ 19.103-77. ЕСПД. Обозначение программ и программных документов. ГОСТ 19.104-78. ЕСПД. Основные надписи. ГОСТ 19.105-78. ЕСПД. Общие требования к программным документам. ГОСТ 19.106-78. ЕСПД. Требования к программным документам, выполненным печатным способом. ГОСТ 19.201-78. ЕСПД. Техническое задание. Требования к содержанию и оформлению. ГОСТ 19.202-78. ЕСПД. Спецификация. Требования к содержанию и оформлению. ГОСТ 19.301-79. ЕСПД. Программа и методика испытаний. Требования к содержанию и оформлению.
ГОСТ 19.401-78. ЕСПД. Текст программы. Требования к содержанию и оформлению. ГОСТ 19.402-78. ЕСПД. Описание программы. ГОСТ 19.403-79. ЕСПД. Ведомость держателей подлинников. ГОСТ 19.404-79. ЕСПД. Пояснительная записка. Требования к содержанию и оформлению. ГОСТ 19.501-78. ЕСПД. Формуляр. Требования к содержанию и оформлению. ГОСТ 19.502-78. ЕСПД. Описание применения. Требования к содержанию и оформлению. ГОСТ 19.503-79. ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению. ГОСТ 19.504-79. ЕСПД. Руководство программиста. Требования к содержанию и оформлению. ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению. ГОСТ 19.506-79. ЕСПД. Описание языка. Требования к содержанию и оформлению. ГОСТ 19.507-79. ЕСПД. Ведомость эксплуатационных документов. ГОСТ 19.508-79. ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению. ГОСТ 19.601-78. ЕСПД. Общие правила дублирования, учета и хранения. ГОСТ 19.602-78. ЕСПД. Правила дублирования, учета и хранения программных документов, выполненных печатным способом. ГОСТ 19.603-78. ЕСПД. Общие правила внесения изменений. ГОСТ 19.604-78. ЕСПД. Правила внесения изменений в программные документы, выполненные печатным способом. ГОСТ 19.701-90 (ИСО 5807-85). ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.
ГОСТ 19.102-77 - стандарт, устанавливающий стадии разработки программ и программной документации для вычислительных машин, комплексов и систем. Стадии описаны в таблице:
Данные требования прописаны в ГОСТ 19.105-78. Программный документ может быть представлен на различных типax носителей данных. Программный документ состоит из следующих условных частей: титульной; информационной; основной; регистрации изменений. Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.
Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа - по ГОСТ 19.104-78. Информационная часть должна состоять из аннотации и содержания. Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы. В аннотации приводят сведения о назначении документа и краткое изложение его основной части. Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят: обозначение структурного элемента (номер раздела, подраздела и т.п.); наименование структурного элемента; адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т. п.).
Правила обозначения структурных элементов основной части документа и их адресации устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных. Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы. О каждом изменении программного документа в этой части делается запись в соответствии с требованиями ГОСТ 19.603-78.
Техническое задание оформляют в соответствии с ГОСТ 19.106-78 на листах формата 11 и 12 по ГОСТ 2.301-68, как правило, без заполнения полей листа. Номера листов (страниц) проставляют в верхней части листа над текстом. Лист утверждения и титульный лист оформляют в соответствии с ГОСТ 19.104-78. Информационную часть (аннотацию и содержание), лист регистрации изменений допускается в документ не включать.
Для внесения изменений или дополнений в техническое задание на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему. Согласование и утверждение дополнения к техническому заданию проводят в том же порядке, который установлен для технического задания. Техническое задание должно содержать следующие разделы: введение; основания для разработки; назначение разработки; требования к программе или программному изделию; требования к программной документации; технико-экономические показатели; стадии и этапы разработки; порядок контроля и приемки; в техническое задание допускается включать приложения. В зависимости от особенностей программы или программного изделия допускается уточнять содержание разделов, вводить новые разделы или объединять отдельные из них.
Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является необязательным. Пояснительная записка должна содержать следующие разделы: введение; назначение и область применения; технические характеристики; ожидаемые технико-экономические показатели; источники, использованные при разработке. В зависимости от особенностей документа отдельные разделы (подразделы) допускается объединять, а также вводить новые разделы (подразделы).
Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным. Руководство оператора должно содержать следующие разделы: назначение программы; условия выполнения программы; выполнение программы; сообщения оператору. В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным. Руководство программиста должно содержать следующие разделы: назначение и условия применения программы; характеристики программы; обращение к программе; входные и выходные данные; сообщения. В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным. Руководство системного программиста должно содержать следующие разделы: общие сведения о программе; структура программы; настройка программы; проверка программы; дополнительные возможности; сообщения системному программисту. В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые. В обоснованных случаях допускается раздел "Дополнительные возможности" не приводить, а в наименованиях разделов опускать слово "программа" или заменять его на "наименование программы".
Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является необязательным. Документ "Программа и методика испытаний" должен содержать следующие разделы: объект испытаний; цель испытаний; требования к программе; требования к программной документации; средства и порядок испытаний; методы испытаний. В зависимости от особенностей документа допускается вводить дополнительные разделы.
Схемы алгоритмов, программ, данных и систем (далее - схемы) состоят из имеющих заданное значение символов, краткого пояснительного текста и соединяющих линий. С хемы могут использоваться на различных уровнях детализации, причем число уровней зависит от размеров и сложности задачи обработки данных. Уровень детализации должен быть таким, чтобы различные части и взаимосвязь между ними были понятны в целом. В настоящем стандарте определены символы, предназначенные для использования в документации по обработке данных, и приведено руководство по условным обозначениям для применения их в: 1) схемах данных; 2) схемах программ; 3) схемах работы системы; 4) схемах взаимодействия программ; 5) схемах ресурсов системы.
В стандарте используются следующие понятия: 1) основной символ - символ, используемый в тех случаях, когда точный тип (вид) процесса или носителя данных неизвестен или отсутствует необходимость в описании фактического носителя данных; 2) специфический символ - символ, используемый в тех случаях, когда известен точный тип (вид) процесса или носителя данных или когда необходимо описать фактический носитель данных; 3) схема - графическое представление определения, анализа или метода решения задачи, в котором используются символы для отображения операций, данных, потока, оборудования и т. д.
Схема данных Схемы данных отображают путь данных при решении задач и определяют этапы обработки, а также различные применяемые носители данных. Схема данных состоит из: 1) символов данных (символы данных могут также указывать вид носителя данных); 2) символов процесса, который следует выполнить над данными (символы процесса могут также указывать функции, выполняемые вычислительной машиной); 3) символов линий, указывающих потоки данных между процессами и (или) носителями данных; 4) специальных символов, используемых для облегчения написания и чтения схемы. Символы данных предшествуют и следуют за символами процесса. Схема данных начинается и заканчивается символами данных (за исключением специальных символов, указанных в п. 3.4).
Схема программы Схемы программ отображают последовательность операций в программе. Схема программы состоит из: 1) символов процесса, указывающих фактические операции обработки данных (включая символы, определяющие путь, которого следует придерживаться с учетом логических условий); 2) линейных символов, указывающих поток управления; 3) специальных символов, используемых для облегчения написания и чтения схемы.
Схема работы системы Схемы работы системы отображают управление операциями и поток данных в системе. Схема работы системы состоит из: 1) символов данных, указывающих на наличие данных (символы данных могут также указывать вид носителя данных); 2) символов процесса, указывающих операции, которые следует выполнить над данными, а также определяющих логический путь, которого следует придерживаться; 3) линейных символов, указывающих потоки данных между процессами и (или) носителями данных, а также поток управления между процессами; 4) специальных символов, используемых для облегчения написания и чтения блок - схемы.
Схема взаимодействия программ Схемы взаимодействия программ отображают путь активаций программ и взаимодействий с соответствующими данными. Каждая программа в схеме взаимодействия программ показывается только один раз (в схеме работы системы программа может изображаться более чем в одном потоке управления). Схема взаимодействия программ состоит из: 1) символов данных, указывающих на наличие данных; 2) символов процесса, указывающих на операции, которые следует выполнить над данными; 3) линейных символов, отображающих поток между процессами и данными, а также инициации процессов; 4) специальных символов, используемых для облегчения написания и чтения схемы.
Схема ресурсов системы Схемы ресурсов системы отображают конфигурацию блоков данных и обрабатывающих блоков, которая требуется для решения задачи или набора задач. Схема ресурсов системы состоит из: 1) символов данных, отображающих входные, выходные и запоминающие устройства вычислительной машины; 2) символов процесса, отображающих процессоры (центральные процессоры, каналы и т. д.); 3) линейных символов, отображающих передачу данных между устройствами ввода - вывода и процессорами, а также передачу управления между процессорами; 4) специальных символов, используемых для облегчения написания и чтения схемы.
Символы данных Основные символы данных Данные Символ отображает данные, носитель данных не определен. Запоминаемые данные Символ отображает хранимые данные в виде, пригодном для обработки, носитель данных не определен. Специфические символы данных Оперативное запоминающее устройство Символ отображает данные, хранящиеся в оперативном запоминающем устройстве.
Запоминающее устройство с последовательным доступом Символ отображает данные, хранящиеся в запоминающем устройстве с последовательным доступом (магнитная лента, кассета с магнитной лентой, магнитофонная кассета). Запоминающее устройство с прямым доступом Символ отображает данные, хранящиеся в запоминающем устройстве с прямым доступом (магнитный диск, магнитный барабан, гибкий магнитный диск). Документ Символ отображает данные, представленные на носителе в удобочитаемой форме ( машинограмма, документ для оптического или магнитного считывания, микрофильм, рулон ленты с итоговыми данными, бланки ввода данных).
Ручной ввод Символ отображает данные, вводимые вручную во время обработки с устройств любого типа (клавиатура, переключатели, кнопки, световое перо, полоски со штриховым кодом). Карта Символ отображает данные, представленные на носителе в виде карты (перфокарты, магнитные карты, карты со считываемыми метками, карты с отрывным ярлыком, карты со сканируемыми метками). Бумажная лента Символ отображает данные, представленные на носителе в виде бумажной ленты. Дисплей Символ отображает данные, представленные в человекочитаемой форме на носителе в виде отображающего устройства (экран для визуального наблюдения, индикаторы ввода информации ).
Символы процесса Основные символы процесса Процесс Символ отображает функцию обработки данных любого вида (выполнение определенной операции или группы операций, приводящее к изменению значения, формы или размещения информации или к определению, по которому из нескольких направлений потока следует двигаться). Специфические символы процесса Предопределенный процесс Символ отображает предопределенный процесс, состоящий из одной или нескольких операций или шагов программы, которые определены в другом месте (в подпрограмме, модуле). Ручная операция Символ отображает любой процесс, выполняемый человеком.
Подготовка Символ отображает модификацию команды или группы команд с целью воздействия на некоторую последующую функцию (установка переключателя, модификация индексного регистра или инициализация программы). Решение Символ отображает решение или функцию переключательного типа, имеющую один вход и ряд альтернативных выходов, один и только один из которых может быть активизирован после вычисления условий, определенных внутри этого символа. Соответствующие результаты вычисления могут быть записаны по соседству с линиями, отображающими эти пути. Параллельные действия Символ отображает синхронизацию двух или более параллельных операций. _________________________________ _________________________________
Граница цикла Символ, состоящий из двух частей, отображает начало и конец, цикла. Обе части символа имеют один и тот же идентификатор. Условия для инициализации, приращения, завершения и т. д. помещаются внутри символа в начале или в конце в зависимости от расположения операции, проверяющей условие.
Символы линий Основной символ линий Линия Символ отображает поток данных или управления. ___________________________ При необходимости или для повышения удобочитаемости могут быть добавлены стрелки - указатели. Специфические символы линий Передача управления Символ отображает непосредственную передачу управления от одного процесса к другому, иногда с возможностью прямого возвращения к инициирующему процессу после того, как инициированный процесс завершит свои функции. Тип передачи управления должен быть назван внутри символа (например, запрос, вызов, событие).
Канал связи Символ отображает передачу данных по каналу связи. Пунктирная линия Символ отображает альтернативную связь между двумя или более символами. Кроме того, символ используют для обведения аннотированного участка. Специальные символы Соединитель Символ отображает выход в часть схемы и вход из другой части этой схемы и используется для обрыва линии и продолжения ее в другом месте. Соответствующие символы - соединители должны содержать одно и то же уникальное обозначение.
Терминатор Символ отображает выход во внешнюю среду и вход из внешней среды (начало или конец схемы программы, внешнее использование и источник или пункт назначения данных). Комментарий Символ используют для добавления описательных комментариев или пояснительных записей в целях объяснения или примечаний. Пунктирные линии в символе комментария связаны с соответствующим символом или могут обводить группу символов. Текст комментариев или примечаний должен быть помещен около ограничивающей фигуры. Пропуск Символ (три точки) используют в схемах для отображения пропуска символа или группы символов, в которых не определены ни тип, ни число символов. Символ используют только в символах линии или между ними. Он применяется главным образом в схемах, изображающих общие решения с неизвестным числом повторений.
