Слайд 1Документирование программного обеспечения
Слайд 2Единая система программной документации (ЕСПД)
http://www.standards.ru – российский научно-технический центр информации
по стандартизации, метрологии и оценке соответствия «Стандартинформ».
gostrf.com
Слайд 3Стандартизация – это деятельность по установлению правил и характеристик в
целях их добровольного многократного использования, направленная на достижение упорядоченности в
сферах производства и обращения продукции и повышение конкурентоспособности продукции, работ или услуг.
Слайд 4Стандарт – это нормативный документ по стандартизации, разработанный, как правило,
на основе согласия, характеризующегося отсутствием возражений по существенным вопросам у
большинства заинтересованных сторон, принятый (утвержденный) признанным органом (предприятием).
Слайд 5Назначение ЕСПД
Единая система программной документации - комплекс государственных стандартов, устанавливающих
взаимоувязанные правила разработки, оформления и обращения программ и программной документации.
Слайд 6В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и
эксплуатацию программ.
Слайд 7Что обеспечивает возможность:
унификации программных изделий для взаимного обмена программами и
применения ранее разработанных, программ в новых разработках;
снижения трудоемкости и повышения
эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;
автоматизации изготовления и хранения программной документации.
Слайд 8Область распространения и состав ЕСПД
Правила и положения, установленные в стандартах
ЕСПД, распространяются на программы и программную документацию для вычислительных машин,
комплексов и систем независимо от их назначения и области применения.
Слайд 9В состав ЕСПД входят:
основополагающие и организационно-методические стандарты;
стандарты, определяющие формы и
содержание программных документов, применяемых при обработке данных;
стандарты, обеспечивающие автоматизацию разработки
программных документов.
Слайд 10Классификация и обозначение стандартов ЕСПД
Слайд 11Обозначения стандартов ЕСПД строят по классификационному признаку.
В обозначение стандарта ЕСПД
должны входить:
цифры 19, присвоенных классу стандартов ЕСПД;
одна цифра (после точки),
обозначающая код классификационной группы стандартов, указанной в п. 3.1;
двузначное число, определяющее порядковый номер стандарта в группе;
двузначное число (после тире), указывающее год регистрации стандарта.
Слайд 12Пример обозначения стандарта «Единая система программной документации. Общие положения»
Слайд 13ГОСТ 19.001-77 ЕСПД. Общие положения.
ГОСТ 19.101-77 ЕСПД. Виды программ и
программных документов (переиздан в ноябре 1987г с изм.).
ГОСТ 19.102-77 ЕСПД.
Стадии разработки.
ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.
ГОСТ 19.104-78 ЕСПД. Основные надписи.
ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам.
Слайд 14ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом.
ГОСТ
19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.
ГОСТ 19.202-78
ЕСПД. Спецификация. Требования к содержанию и оформлению.
ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний.
ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению.
Слайд 15ГОСТ 19.402-78 ЕСПД. Описание программы.
ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования
к содержанию и оформлению.
ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию
и оформлению.
ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.
Слайд 16ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и
оформлению.
ГОСТ 19.504-79 ЕСПД. Руководство программиста.
ГОСТ 19.505-79 ЕСПД. Руководство оператора.
ГОСТ 19.506-79
ЕСПД. Описание языка.
ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.
Слайд 17ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые
печатным способом.
ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем.
Условные обозначения и правила выполнения.
Слайд 18Недостатки ЕСПД:
1. не отражены некоторые современные тенденции оформления программ и
программной документации,
2. в этих стандартах наличествует многократное дублирование фрагментов программной
документации.
Слайд 19ГОСТ 19.101-77. ЕСПД. Виды программ и программных документов
Виды программ:
Компонент
– программа, рассматриваемая как единое целое, выполняющая законченную функцию и
применяемая самостоятельно или в составе комплекса.
Комплекс – это программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
Слайд 22Виды эксплуатационных документов
Слайд 23Виды эксплуатационных документов
Слайд 24Техническое задание (ГОСТ 19.201-78)
Стандарт устанавливает порядок построения и оформления технического
задания на разработку программы или программного изделия для вычислительных машин,
комплексов и систем независимо от их назначения и области применения.
Слайд 25Общие положения
Техническое задание оформляют на листах формата А4 и/или А3,
как правило, без заполнения полей листа. Номера листов (страниц) проставляют
в верхней части листа над текстом.
Для внесения изменений и дополнений в техническое задние на последующих стадиях разработки программы или программного изделия выпускают дополнение к нему.
Слайд 26Техническое задание должно содержать следующие разделы:
наименование и область применения (введение);
основание
для разработки;
назначение разработки;
технические требования к программе или программному изделию;
технико-экономические показатели;
стадии
и этапы разработки;
порядок контроля и приемки;
приложения.
Слайд 27Содержание разделов
В разделе Наименование и область применения указывают наименование, краткую
характеристику области применения программы или программного изделия и объекта, в
котором используют программу или программное изделие.
Слайд 28В разделе Основание для разработки должны быть указаны:
документ (документы), на
основании которых ведется разработка;
организация, утвердившая этот документ, и дата его
утверждения;
наименование и (или) условное обозначение темы разработки.
Слайд 29В разделе Назначение разработки должно быть указано функциональное и эксплуатационное
назначение программы или программного изделия. Ограничиться здесь можно одной-двумя фразами.
Слайд 30Раздел Технические требования к программе или программному изделию должен содержать
следующие подразделы:
требования к функциональным характеристикам;
требования к надежности;
условия эксплуатации;
требования к составу
и параметрам технических средств;
требования к информационной и программной совместимости;
требования к маркировке и упаковке;
требования к транспортированию и хранению;
специальные требования.
Слайд 31Требования к функциональным характеристикам. Должны быть указаны требования к составу
выполняемых функций, организации входных и выходных данных, временным характеристикам и
т.п.
Слайд 32Требования к надежности. Должны быть указаны требования к обеспечению надежного
функционирования (обеспечение устойчивого функционирования, контроль входной и выходной информации, время
восстановления после отказа и т.п.).
Слайд 33Условия эксплуатации. Должны быть указаны условия эксплуатации (температура окружающего воздуха,
относительная влажность и т.п. для выбранных типов носителей данных), при
которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
Слайд 34Требования к составу и параметрам технических средств. Указывают необходимый состав
технических средств с указанием их технических характеристик.
Слайд 35Требования к информационной и программной совместимости. Должны быть указаны требования
к информационным структурам на входе и выходе и методам решения,
исходным кодам, языкам программирования. При необходимости должна обеспечиваться защита информации и программ.
Слайд 36Требования к маркировке и упаковке и требования к транспортированию и
хранению Указывают требования к маркировке программного изделия, варианты и способы
упаковки. В требованиях к транспортированию и хранению должны быть указаны для программного изделия условия транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях.
Слайд 37Технико-экономические показатели
В этом разделе должны быть указаны:
ориентировочная экономическая эффективность,
предполагаемая годовая потребность,
экономические преимущества разработки по сравнению с лучшими
отечественными и зарубежными образцами или аналогами.
Слайд 38Стадии и этапы разработки
Устанавливают необходимые стадии разработки, этапы и
содержание работ, а также сроки разработки и исполнители.
Основные этапы
техническое задание,
эскизный проект,
технический,
рабочий проект.
Слайд 39Эскизный проект
Детально разрабатываются структуры входных и выходных данных, определяется форма
их представления. Разрабатывается общее описание алгоритма, сам алгоритм, структура программы.
Разрабатываются план мероприятий по разработке и внедрению программы.
Слайд 40Технический проект
Содержит разработанный алгоритм решения задачи, а также методы контроля
исходной информации.
Разрабатываются средства обработки ошибок и выдачи диагностических сообщений,
определяются формы представления исходных данных и конфигурация технических средств.
Слайд 41Рабочий проект
Осуществляется программирование и отладка программы, разработка программных документов, программы
и методики испытаний. Подготавливаются контрольно-отладочные примеры. Окончательно оформляются документация и
графический материал.
Слайд 42Документация:
текст программы;
описание программы;
программа и методика испытаний;
описание применения;
руководство пользователя.
Слайд 43Порядок контроля и приемки
Указываются виды испытаний и общие требования
к приемке работы.
Слайд 44Приложения к техническому заданию:
перечень научно-исследовательских и других работ, обосновывающих разработку;
схемы
алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут
быть использованы при разработке;
другие источники разработки.
Слайд 45Стадии разработки (ГОСТ 19.102-77)
Стандарт устанавливает стадии разработки программ, программной документации,
а также этапы и содержание работ.
Слайд 46Описание программы (ГОСТ 19.402-78)
Стандарт ориентирован на документирование результирующего продукта разработки.
Описание
программы обязательно должно включать
информационную часть – аннотацию;
содержание.
Слайд 47Основная часть документа должна состоять из вводной части и следующих
разделов:
функциональное назначение;
описание логики.
условия применения;
состав и функции.
Слайд 48В Вводной части документа приводится информация общего характера о программе
- полное наименование, обозначение, ее возможные применения и т.п.
В разделе
Назначение указывают назначение программы и приводят общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы, а также указывают типы электронных вычислительных машин и устройств, которые используются при работе.
Слайд 49В разделе Описание логики указывают:
описание структуры программы и ее основных
частей;
описание функций составных частей и связей между ними;
сведения о языке
программирования;
описание входных и выходных данных для каждой из составных частей;
описание логики составных частей.
При описании логики программы необходима привязка к тексту программы.
Слайд 50В разделе Состав и функции указывают описание состава и функции
программ, применяемых методов решения задач.
В разделе Условия применения указываются условия,
необходимые для выполнения программы.
Слайд 51В Приложение к описанию могут быть включены справочные материалы (иллюстрации,
таблицы, графики, примеры и т.п.), имя загрузочного модуля, а также
описание всей процедуры Вызова и загрузки системы.
Слайд 52Текст программы (ГОСТ 19.401-78)
Текст программы должен быть удобочитаемым.
Составляется информационная часть
- аннотация и содержание.
Основная часть документа должна состоять из текстов
одного или нескольких разделов, которым даны наименования.
Слайд 53Текст каждого программного файла начинается с "шапки", в которой указывается:
наименование
программы,
автор,
дата создания программы,
номер версии,
дата последней модификации.
Обязательными являются комментарии, а также
строгое соблюдение правил отступа.