Файл: Документирование программного обеспечения Единая система программной документации (еспд).pptx
ВУЗ: Не указан
Категория: Не указан
Дисциплина: Не указана
Добавлен: 29.11.2023
Просмотров: 131
Скачиваний: 1
СОДЕРЖАНИЕ
Документирование программного обеспечения
Единая система программной документации (ЕСПД)
Область распространения и состав ЕСПД
Классификация и обозначение стандартов ЕСПД
Обозначения стандартов ЕСПД строят по классификационному признаку.
В обозначение стандарта ЕСПД должны входить:
Пример обозначения стандарта «Единая система программной документации. Общие положения»
1. не отражены некоторые современные тенденции оформления программ и программной документации,
2. в этих стандартах наличествует многократное дублирование фрагментов программной документации.
ГОСТ 19.101-77. ЕСПД. Виды программ и программных документов
Техническое задание (ГОСТ 19.201-78)
Техническое задание должно содержать следующие разделы:
В разделе Основание для разработки должны быть указаны:
Технико-экономические показатели
В этом разделе должны быть указаны:
Содержит разработанный алгоритм решения задачи, а также методы контроля исходной информации.
Указываются виды испытаний и общие требования к приемке работы.
Приложения к техническому заданию:
Стадии разработки (ГОСТ 19.102-77)
Описание программы (ГОСТ 19.402-78)
Стандарт ориентирован на документирование результирующего продукта разработки.
Описание программы обязательно должно включать
Основная часть документа должна состоять из вводной части и следующих разделов:
В разделе Описание логики указывают:
В разделе Условия применения указываются условия, необходимые для выполнения программы.
Текст программы (ГОСТ 19.401-78)
Текст программы должен быть удобочитаемым.
Составляется информационная часть - аннотация и содержание.
Текст каждого программного файла начинается с "шапки", в которой указывается:
Технико-экономические показатели
В этом разделе должны быть указаны:
- ориентировочная экономическая эффективность,
- предполагаемая годовая потребность,
- экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами.
Стадии и этапы разработки
Устанавливают необходимые стадии разработки, этапы и содержание работ, а также сроки разработки и исполнители.
Основные этапы
- техническое задание,
- эскизный проект,
- технический,
- рабочий проект.
Эскизный проект
Детально разрабатываются структуры входных и выходных данных, определяется форма их представления. Разрабатывается общее описание алгоритма, сам алгоритм, структура программы. Разрабатываются план мероприятий по разработке и внедрению программы.Технический проект
Содержит разработанный алгоритм решения задачи, а также методы контроля исходной информации.
Разрабатываются средства обработки ошибок и выдачи диагностических сообщений, определяются формы представления исходных данных и конфигурация технических средств.
Рабочий проект
Осуществляется программирование и отладка программы, разработка программных документов, программы и методики испытаний. Подготавливаются контрольно-отладочные примеры. Окончательно оформляются документация и графический материал.Документация:
- текст программы;
- описание программы;
- программа и методика испытаний;
- описание применения;
- руководство пользователя.
Порядок контроля и приемки
Указываются виды испытаний и общие требования к приемке работы.
Приложения к техническому заданию:
- перечень научно-исследовательских и других работ, обосновывающих разработку;
- схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;
- другие источники разработки.
Стадии разработки (ГОСТ 19.102-77)
Стандарт устанавливает стадии разработки программ, программной документации, а также этапы и содержание работ.
Описание программы (ГОСТ 19.402-78)
Стандарт ориентирован на документирование результирующего продукта разработки.
Описание программы обязательно должно включать
- информационную часть – аннотацию;
- содержание.
Основная часть документа должна состоять из вводной части и следующих разделов:
- функциональное назначение;
- описание логики.
- условия применения;
- состав и функции.
В Вводной части документа приводится информация общего характера о программе - полное наименование, обозначение, ее возможные применения и т.п.
В разделе Назначение указывают назначение программы и приводят общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы, а также указывают типы электронных вычислительных машин и устройств, которые используются при работе.В разделе Описание логики указывают:
- описание структуры программы и ее основных частей;
- описание функций составных частей и связей между ними;
- сведения о языке программирования;
- описание входных и выходных данных для каждой из составных частей;
- описание логики составных частей.
При описании логики программы необходима привязка к тексту программы.
В разделе Состав и функции указывают описание состава и функции программ, применяемых методов решения задач.
В разделе Условия применения указываются условия, необходимые для выполнения программы.
В Приложение к описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.), имя загрузочного модуля, а также описание всей процедуры Вызова и загрузки системы.Текст программы (ГОСТ 19.401-78)
Текст программы должен быть удобочитаемым.
Составляется информационная часть - аннотация и содержание.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
Текст каждого программного файла начинается с "шапки", в которой указывается:
- наименование программы,
- автор,
- дата создания программы,
- номер версии,
- дата последней модификации.