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

Единая система программной документации
ЕСПД – это комплекс государственных стандартов устанавливающих
взаимосвязанные правила разработки и обращения программ и программной
документации. В стандарт ЕСПД установлены требования регламентирующие разработку
сопровождения, изготовления и эксплуатацию программ, что обеспечивает возможность:
1)
Унификации программных изделий для обмена программами и применение
ранних разработанных программ в новых разработках
2)
Снижение трудоемкости разработки
3)
Автоматизация изготовления и хранения программной документацию
Сопровождение программы включает анализ функционирования, развитие и
совершенствование программы, а так же внесение изменения в нее с целью устранения
ошибок.
Правила и положения, установленные в стандартах ЕСПД распространяется на
программы и программную документацию для вычислительных машинных комплексов и
систем независимо от их назначения и области применения.
В состав ЕСПД входят:
1) Основополагающие и организационно методические стандарты
2) Стандарты, определяющие форму и содержание программных документов
применяемых для обработки данных
3) Стандарты, обеспечивающие автоматизацию разработки программных документов
Разработка организационно методической документации определяющей и
регламентирующей деятельностью организации по разработке сопровождении и
эксплуатации программ должно производится на основе стандартов ЕСПД.
Стандарты ЕСПД разделяются на группы:
- 0 код групп об общем положении
- 1 код группы основополагающей стандартов
- 2 код правила выполнения документации разработки
- 3 код правила выполнения документации изготовителя
- 4 код правила выполнения документации сопровождения
- 5 код правила выполнения эксплуатационных документов
- 6 код правила обращения программной документации
- 7-8 резервные группы
- 9 прочие стандарты
Обозначение стандартов ЕСПД строятся по классификационному признаку.
В обозначении стандартов ЕСПД должны входить:
1) Цифры 1 9 присвоены классу стандартов ЕСПД
2) Одна цифра после точки (.) обозначающая код классификационной группы
стандартов.
3) Двузначное число, определяющее порядковый номер группы
4) Двузначное число после тире (-) указывающее год регистрации стандартов.
Схемы алгоритмов программ данных и систем.
Они состоят из имеющих заданное значение символов краткого пояснительного текста
и соединяющие линии. Схемы могут использоваться на различных уровнях детализации,
причем число уровней зависит от размеров и сложности задачи обработки данных.
Уровень детализации должен быть таким, что бы различные части и взаимосвязь между
ними были по тип в целом. Символы предназначены для использования в документации
по обработке данных и применения в:
1) схемах данных
2) схемах программ
3) схемах работы в системе
4) схемах взаимодействия программ
5) схемах ресурсов системы
I)
Схемы данных – отображают путь данных при решении задач и определяют этапы
обработки, а так же различных применяемых носителях данных.
II) Схема программ – отображают последовательность операций программ
III) Схема работы в системе – отображают управление операциями и поток данных в
системе
IV) Схема взаимодействия программ – отображает путь активации программ и
взаимодействий с соответствующими данными. Каждая программа в схеме
взаимодействия показывается только 1раз.
V) Схема ресурсов в системе – отображает конфигурацию блоков данных и
обрабатывающих блоков, которые требуются для решения задачи или набора
задач.
I
Данные, носитель
не определен
Документ, данные
предоставлены на носителе
в удобной форме
Ручной
ввод
II
Решение функции переключательного типа, имеющее один
вход и ряд альтернативных выходов, один из которых может
быть активизирован после вычисления условий
Процесс, обработка
данных любого вида
III
Линия, поток данных или управление
Канал связи, передача данных по каналу связи
Пунктирная линия, альтернативная связь
IV Специальные символы
1. Соединитель выход в часть схемы, и вход из другой части схемы
2.
- терминатор вход во внешнюю среду и выход из внешней среды
3.
комментарий, пояснительная запись
Тема: ЕСПД – основополагающие стандарты
Программу допускается идентифицировать и применять самостоятельно или в составе
других программ. Программы подразделяются на:
1) компонент – программа рассматриваемая, как единое целое, выполняющее
законченную функцию и применяемое самостоятельно или в составе комплекса
2) Комплекс – программа, состоящая из двух или нескольких компонентов или
комплексов, выполняющих взаимосвязанные функции и применяемое
самостоятельно или в составе другого комплекса
Документация, разработанная на программу может использоваться для реализации и
передачи программ на носителях данных, а так же для изготовления. К ПИ относятся
документы, содержащие сведения необходимые для разработки изготовления,
сопровождения и эксплуатации программ.
Виды программных документов
1) Спецификация – содержит состав, программу и документацию на нее
2) Ведомость держателей подлинников - это перечень предприятий, на которых
хранят подлинники программных документов (код 05)
3) Текст программы – это запись программы с необходимыми комментариями (код
12)
4) Описание программ – содержит сведения с логической структурой и
функционированием программы (код 13)
5) Программа и методика испытаний содержит требования подлежащие проверке
при испытании программы, а так же порядок и методы их контроля (код 51)
6) Техническое задание указывает назначение и область применения программы,
содержит технические, технико-экономические и специальные требования,
предъявляемые программе. Необходимые стадии и сроки разработки, и виды
испытаний
7) Пояснительная записка содержит схему алгоритмов, общее описание алгоритма и
функционирование программы, а так же обоснование принятых технических и
технико-экономических решений (код 81)
8) Эксплуатационные документы содержат сведения для обеспечения
функционирования и эксплуатации программы. К эксплуатационным документам
относятся:
а) ведомость эксплуатационных документов содержащее перечень
эксплуатационных документов на программу (код 20)
б) формуляр, содержащее основные характеристики программ, комплектность и
сведения об эксплуатации программ (код30)
в) описание применения содержащее сведения о назначении программы, области
применения, применяемых методов, класс решаемых задач ограничения для
применения минимальной конфигурации технических средств (код 31)
г) руководство системного программиста содержащее сведения проверки
обеспечения функционирования и постройки программ на условиях конкретного
применения (код 32)
д) руководство программиста, содержащее сведения для эксплуатации программ
(код 32)
е) руководство операторов содержащее сведения для обеспечения процедуры
общения оператора с вычислительной системой в процессе выполнения программы
(код 34)
ж) описание языка содержащее описание синтаксиса и семантики языка (код 35)
з) руководство по техническому обслуживанию содержащее сведения для
применения тестовых и диагностических программ при обслуживании технических
средств (код 46)
Не все документы обязательны, необходимость составления документов
определяется на этапе разработки и утверждении технического задания.
Стадии разработки программ
I)
II)
III)
IV)
V)
Техническое задание – на этапе обоснования необходимости разработки
программы формируют постановку задачи проводят сбор исходных материалов
выбор и обоснование критерии эффективности и качества разрабатываемой
программы, обоснование необходимости проведения научно-исследовательских
работ, на этом этапе определяют структуру входных и выходных данных проводит
предварительный выбор методов решения задач, обосновывает целесообразность
применения ранее разработанных программ, определяют требования технических
средств, обосновывает принципиальную возможность решения задач. На этом
этапе разработки и утверждения технических заданий, определяют требования к
программе, разрабатывает технико-экономическое задание разработки программы,
определяющее стадии этапов и сроков программы и документации для нее
выбирают язык программирования, определяют необходимость проведения
научно-исследовательских работ на последующих стадиях, согласовывают и
утверждают технических заданий.
Эскизный проект. На этапе проводят предварительную разработку структур вход
и выход данных, уточняют методы решения задачи, разрабатывают общее
описание алгоритма решения задачи и технико-экономическое обоснование. На
этом этапе утверждения разрабатывают пояснительную записку, согласовывают и
утверждают эскизный проект.
Технический проект. На этом этапе разработки уточняют структуру входных и
выходных данных, разрабатывают алгоритм решения задачи, определяют форму
представления входных и выходных данных, определяют семантику и синтаксис
языка, разрабатывают структуру программы, окончательно определяют
конфигурацию технических средств. На этом этапе утверждения разрабатывают
план мероприятий по разработке и внедрению программ. Разрабатывают
пояснительную записку, согласовывают и утверждают технический проект.
Рабочий проект. На этом этапе разработки осуществляется программирование и
отладка программы. На этапе разработки программной документации
разрабатывают программные документы в соответствии с требованиями ГОСТа.
На этапе испытания программы проводят разработку, согласование и утверждение
программы и методики испытаний, на этапе испытания проводят предварительные
государственные, межведомственные, приемосдаточные и другие виды испытаний.
Корректируют программу и программную документацию по результатам
испытаний.
Внедрение. На этапе подготовки передачи программ осуществляют подготовку
передачи программы и программной документации для сопровождения и
изготовления, оформляют и утверждают акт о передаче программы на
сопровождение и изготовление, передают программу в фонд алгоритмов и
программ.
Обозначение программ и программных документов
Оно состоит из групп знаков разделенных точками, пробелами и дефисами.
Структура обозначения его программы и ее программного документа.
1)
2)
3)
4)
номер издания для программы (номер редакции для документа)
регистрационный номер
код организации разработчика
код страны
Структура обозначения других программных документов
1) номер редакции документа
2) код вида документа
3) номер документа данного вида
4) номер части документа
Код прочих документов устанавливают с 90-99г.
Общие требования к программным документам
Программный документ может быть представлен на разных типах носителей
данных. Состоит из условных частей:
1) титульная
2) информационная
3) основная
4) регистрация изменений
I)
Титульная часть состоит из листа утверждения и титульного листа
II) Должна состоять из аннотаций и содержаний в аннотации приводят сведения о
назначении документа и краткое изложение его основной части. Содержание
включает перечень записей о структурных элементов основной части документа в
каждую из которых входят: обозначение структурного элемента, наименование
структурного элемента на носителях данных. Лист утверждения выпускается на
каждый программный документ (АИ) независимо от вида документа, который
может быть выполнен на любом носителе данных.
VI)
Общее количество листов утверждения, объем документа
VII) Сведения о разработчиках
VIII) Подпись нормоконтролера
IX)
Сведения об изменениях
Форма листа утверждения
Наименование министерства или ведомства в систему которого входит
организация, разработавшая данный документ, заполняют по требованию
заказчика, в правом нижнем углу над полем один при необходимости ставят
специальную отметку. Пример: Гриф секретности указания с предприятия не
выносят.
II)
В правой части должности, подписи лиц утвердивших документ, справа от каждой
подписи предоставляется фамилии.
III)
Полное наименование программы или программного изделия прописными
буквами.
IV)
Обозначение документа
V)
Объем документа
VI)
В правой части должности и подписи руководителей организации выпустившей
документ
VII) Год издания (только цифры)
VIII) Отметка об учете и хранении
IX)
Строка изменения
I)
Титульный лист
Заполнить по форме и правилам установленных для ЛУ, при этом поле 1 заполнять
по требованию заказчика, поле 2 не заполнять, поле 3 полное наименование программы,
наименования документа, поле 4 обозначение документа указание носителя данных, поле
5 указывает объем документа, поле 6 не заполнять, поле 7 год издания документа, поле 8
отметка об учете хранения.
На титульном листе в левом верхнем углу должна быть подпись : утвержден