Файл: Документирование программного обеспечения Единая система программной документации (еспд).pptx

СОДЕРЖАНИЕ

Документирование программного обеспечения

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

http://www.standards.ru – российский научно-технический центр информации по стандартизации, метрологии и оценке соответствия «Стандартинформ».

gostrf.com

Назначение ЕСПД

Единая система программной документации - комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации.

В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ.

Что обеспечивает возможность:

Область распространения и состав ЕСПД

В состав ЕСПД входят:

Классификация и обозначение стандартов ЕСПД

Обозначения стандартов ЕСПД строят по классификационному признаку.

В обозначение стандарта ЕСПД должны входить:

Пример обозначения стандарта «Единая система программной документации. Общие положения»

Недостатки ЕСПД:

1. не отражены некоторые современные тенденции оформления программ и программной документации,

2. в этих стандартах наличествует многократное дублирование фрагментов программной документации.

ГОСТ 19.101-77. ЕСПД. Виды программ и программных документов

Виды программ:

Компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса.

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

Техническое задание (ГОСТ 19.201-78)

Общие положения

Техническое задание оформляют на листах формата А4 и/или А3, как правило, без заполнения полей листа. Номера листов (страниц) проставляют в верхней части листа над текстом.

Для внесения изменений и дополнений в техническое задние на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему.

Техническое задание должно содержать следующие разделы:

Содержание разделов

В разделе Основание для разработки должны быть указаны:

В разделе Назначение разработки должно быть указано функциональное и эксплуатационное назначение программы или программного изделия. Ограничиться здесь можно одной-двумя фразами.

Раздел Технические требования к программе или программному изделию должен содержать следующие подразделы:

Требования к функциональным характеристикам. Должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т.п.

Требования к составу и параметрам технических средств. Указывают необходимый состав технических средств с указанием их технических характеристик.

Технико-экономические показатели

В этом разделе должны быть указаны:

Стадии и этапы разработки

Устанавливают необходимые стадии разработки, этапы и содержание работ, а также сроки разработки и исполнители.

Основные этапы

Эскизный проект

Технический проект

Содержит разработанный алгоритм решения задачи, а также методы контроля исходной информации.

Разрабатываются средства обработки ошибок и выдачи диагностических сообщений, определяются формы представления исходных данных и конфигурация технических средств.

Рабочий проект

Документация:

Порядок контроля и приемки

Указываются виды испытаний и общие требования к приемке работы.

Приложения к техническому заданию:

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

Стандарт устанавливает стадии разработки программ, программной документации, а также этапы и содержание работ.

Описание программы (ГОСТ 19.402-78)

Стандарт ориентирован на документирование результирующего продукта разработки.

Описание программы обязательно должно включать

Основная часть документа должна состоять из вводной части и следующих разделов:

В Вводной части документа приводится информация общего характера о программе - полное наименование, обозначение, ее возможные применения и т.п.

В разделе Описание логики указывают:

В разделе Состав и функции указывают описание состава и функции программ, применяемых методов решения задач.

В разделе Условия применения указываются условия, необходимые для выполнения программы.

Текст программы (ГОСТ 19.401-78)

Текст программы должен быть удобочитаемым.

Составляется информационная часть - аннотация и содержание.

Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.

Текст каждого программного файла начинается с "шапки", в которой указывается: