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

ВУЗ: Не указан

Категория: Не указан

Дисциплина: Не указана

Добавлен: 29.11.2023

Просмотров: 132

Скачиваний: 1

ВНИМАНИЕ! Если данный файл нарушает Ваши авторские права, то обязательно сообщите нам.

СОДЕРЖАНИЕ

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

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

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)

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

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

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

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

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

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

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

gostrf.com

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

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

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

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

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

  • унификации программных изделий для взаимного обмена программами и применения ранее разработанных, программ в новых разработках;
  • снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;
  • автоматизации изготовления и хранения программной документации.

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

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

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

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

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


Код группы

Наименование группы

0

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

1

Основополагающие стандарты

2

Правила выполнения документации разработки

3

Правила выполнения документации изготовления

4

Правила выполнения документации сопровождения

5

Правила выполнения эксплуатационной документации

6

Правила обращения программной документации

7

Резервные группы

8

9

Прочие стандарты

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

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

  • цифры 19, присвоенных классу стандартов ЕСПД;
  • одна цифра (после точки), обозначающая код классификационной группы стандартов, указанной в п. 3.1;
  • двузначное число, определяющее порядковый номер стандарта в группе;
  • двузначное число (после тире), указывающее год регистрации стандарта.

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

  • ГОСТ 19.001-77 ЕСПД. Общие положения.
  • ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов (переиздан в ноябре 1987г с изм.).
  • ГОСТ 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.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.
  • ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.
  • ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.
  • ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.
  • ГОСТ 19.504-79 ЕСПД. Руководство программиста.
  • ГОСТ 19.505-79 ЕСПД. Руководство оператора.
  • ГОСТ 19.506-79 ЕСПД. Описание языка.
  • ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

  • ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.
  • ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.

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

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

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

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

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

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

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


Вид программного документа

Содержание программного документа

Спецификация

Состав программы и документации на нее

Ведомость держателей подлинников

Перечень предприятий, на которых хранят подлинники программных документов

Текст программы

Запись программы с необходимыми комментариями

Описание программы

Сведения о логической структуре и функционировании программы

Программа и методика испытаний

Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля

Вид программного документа

Содержание программного документа

Техническое задание

Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний

Пояснительная записка

Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений

Эксплуатационные документы

Сведения для обеспечения функционирования и эксплуатации программы


Вид эксплуатационного документа

Содержание эксплуатационного документа

Ведомость эксплуатационных документов

Перечень эксплуатационных документов на программу

Формуляр

Основные характеристики программы, комплектность и сведения об эксплуатации программы

Описание применения

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

Вид эксплуатационного документа

Содержание эксплуатационного документа

Руководство системного программиста

Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения

Руководство программиста

Сведения для эксплуатации программы

Руководство оператора

Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы

Описание языка

Описание синтаксиса и семантики языка

Руководство по техническому обслуживанию

Сведения для применения тестовых и диагностических программ при обслуживании технических средств

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

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

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

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

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

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

  • наименование и область применения (введение);
  • основание для разработки;
  • назначение разработки;
  • технические требования к программе или программному изделию;
  • технико-экономические показатели;
  • стадии и этапы разработки;
  • порядок контроля и приемки;
  • приложения.

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

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

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

  • документ (документы), на основании которых ведется разработка;
  • организация, утвердившая этот документ, и дата его утверждения;
  • наименование и (или) условное обозначение темы разработки.

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

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

  • требования к функциональным характеристикам;
  • требования к надежности;
  • условия эксплуатации;
  • требования к составу и параметрам технических средств;
  • требования к информационной и программной совместимости;
  • требования к маркировке и упаковке;
  • требования к транспортированию и хранению;
  • специальные требования.

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

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

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

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