Тема 1.4. Виды программ, программной и эксплуатационной документации по еспд.

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

1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.

1.2. Программы подразделяют на виды, приведенные в табл.

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

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

1.2,1.3. (Измененная редакция, Изм. № 1).

Виды программных продуктов

2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.

2.2. Виды программных документов и их содержание.

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

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

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

• Описание программы (код вида документа - 13) - содержит сведения о логической структуре и функционировании программы. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.

• Программа и методика испытаний (код вида документа - 51) - содержит требования, подлежащие проверке при испытаниях программы, а также порядок и методы их контроля. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.

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

• Пояснительная записка (код вида документа - 81) - содержит схему алгоритма, общее описание алгоритма и /или функционирования программы, а также обоснование принятых технических и технико-экономических решений. Выполняется на стадии эскизного и технического проектов. Необходимость - по согласованию.

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

2.3. Виды эксплуатационных документов и их содержание

• Ведомость эксплуатационных документов (код вида документа - 20) - содержит перечень эксплуатационных документов на программу.

• Формуляр (код вида документа - 30) - содержит основные характеристики программы, комплектность и сведения об эксплуатации программы.

• Описание применения (код вида документа - 31) - содержит сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств.

• Руководство системного программиста (код вида документа - 32) - содержит сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.

• Руководство программиста (код вида документа - 33) - содержит сведения для эксплуатации программы.

• Руководство оператора (код вида документа - 34) - содержит сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы.

• Описание языка (код вида документа - 35) - содержит описание синтаксиса и семантики языка.

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

Помимо оговариваемых стандартом, на программу могут выпускаться и другие программные и эксплуатационные документы, им присваиваются коды от 90 до 99.

2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.

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

Код вида документа	Вид документа	Стадии разработки
		Эскизный проект	Технический проект	Рабочий проект
				компонент	комплекс
-	Спецификация	-	-	2	1
05	Ведомость держателей подлинников	-	-	-	3
12	Текст программы	-	-	1	3
13	Описание программы	-	-	3	3
20	Ведомость эксплуатационных документов	-	-	3	3
30	Формуляр	-	-	3	3
31	Описание применения	-	-	3	3
32	Руководство системного программиста	-	-	3	3
33	Руководство программиста	-	-	3	3
34	Руководство оператора	-	-	3	3
35	Описание языка	-	-	3	3
46	Руководство по техническому обслуживанию	-	-	3	3
51	Программа и методика испытаний	-	-	3	3
81	Пояснительная записка	3	3	-	-
90-99	Прочие документы	3	3	3	3

Условные обозначения:

1 - документ обязательный;

2 - документ обязательный для компонентов, имеющих самостоятельное применение;

3 - необходимость составления документа определяется на этапе разработки и утверждения технического задания;

- - документ не составляют.

2.2-2.5. (Измененная редакция, Изм. № 1).

2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.

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

2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.

Технические условия разрабатывают на стадии «Рабочий проект».

2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком. (Введен дополнительно, Изм. № 1).

В общем случае каждый документ должен иметь:

1. титульный лист и наименование документа

2. сформулированное назначение

3. область его действия

4. категории специалистов, для которых он предназначен и кем он разрабатывается

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

6. функциональную, содержательную часть в соответствии с его назначением.

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

Пользователи ПС делятся на два крупных класса, каждый из которых должен быть обеспечен комплектной эксплуатационной документацией:

1. администраторы, подготавливающие ПС к эксплуатации и обеспечивающие их функционирование и использование по прямому назначению.

2. операторы, реализующие функционирование и применение ПС.

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

К основным функциям системы администрирования относят:

1. консультация разработчиков программ и данных по особенностям применения ПС и СУБД.

2. планирование использования памяти и производительности вычислительной системы в рабочем режиме применения ПС.

3. инсталляция версии ПС для пользователя.

4. выявление и регистрация сбоев и дефектов функционирования программ и данных.

5. управление средствами защиты инф-ции и санкционированным доступов пользователей, анализ попыток взлома системы защиты.

6. защита и восстановление инф-ции БД при искажении.

В основу современного пользовательского интерфейса с ПС составляют наборы графических элементов и действий над ними, представляемые как меню и системы окон для манипулирования с изображениями.

Основные особенности современного пользовательского интерфейса состоят в следующем:

1. наличие механизмов управления окнами

2. использование готовых графических символов (икон) для отображения управляемых объектов

3. непосредственное манипулирование графическими объектами и окнами посредством мыши

4. объектно и проблемно-ориентированное проектирование диалоговых систем.

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

Архитектура построения распределенных приложений определяет протоколы и интерфейсы взаимодействия клиентских и серверных частей приложений между собой и с ПС среды распределенной обработки данных при выполнении или функций поддержки интерфейсов пользователя.

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

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

1. соответствия между элементами интерфейса пользователя (экранными формами) и типовыми процедурами

2. последовательность допустимых операций и переходы между экранными формами

3. форма идентификации ошибочных действий или ситуаций

4. формы входных и выходных документов

Обучение представляет собой процесс обеспечения и сопровождения обучаемого персонала.

Правила оформления лабораторных работ.

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

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

В отчет по лабораторной работе должны быть включены следующие пункты:

-       титульный лист;

-       цель работы;

-       краткие теоретические сведения;

-       описание экспериментальной установки и методики эксперимента;

-       экспериментальные результаты;

-       анализ результатов работы;

-       выводы.

Требования к содержанию отдельных частей отчета по лабораторной работе

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

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

В среднем поле указывается вид работы, в данном случае лабораторная работа с указанием курса, по которому она выполнена, и ниже ее название. Название лабораторной работы приводится без слова тема и в кавычки не заключается.

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

В нижнем поле листа указывается место выполнения работы и год ее написания (без слова год).

Цель работы должна отражать тему лабораторной работы, а также конкретные задачи, поставленные студенту на период выполнения работы. По объему цель работы в зависимости от сложности и многозадачности работы составляет от нескольких строк до 0,5 страницы.

Краткие теоретические сведения. В этом разделе излагается краткое теоретическое описание изучаемого в работе явления или процесса, приводятся также необходимые расчетные формулы. Материал раздела не должен копировать содержание методического пособия или учебника по данной теме, а ограничивается изложением основных понятий и законов, расчетных формул, таблиц, требующихся для дальнейшей обработки полученных экспериментальных результатов. Объем литературного обзора не должен превышать 1/3 части всего отчета.

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

Экспериментальные результаты. В этом разделе приводятся непосредственно результаты, полученные в ходе проведения лабораторных работ. Обязательно необходимо оценить погрешности измерений.

Анализ результатов работы. Раздел отчета должен содержать подробный анализ полученных результатов.

Выводы. В выводах кратко излагаются результаты работы.

Отчет по лабораторной работе оформляется на писчей бумаге стандартного формата А4 на одной стороне листа, которые сшиваются в скоросшивателе или переплетаются. Допускается оформление отчета по лабораторной работе только в электронном виде средствами Microsoft Office.

Виды и содержание документации по ЕСПД на этапах разработки технического задания.

Документация при проектировании и разработке ПС.

Для представления и детализации структуры и содержания технологической документации ЖЦ ПС целесообразно разделить на этапы:

1. системный анализ и проектирование ПС – разработка и интегрирование программных компонентов

2. тестирование компонентов и комплексов программ

3. испытание ПС

4. сопровождение и конфигурационное управление версиями ПС.

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

Аннотацию и содержание допускается в документ не включать.

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

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

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

3. Назначение разработки - функциональное и эксплуатационное назначение программы.

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

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

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

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

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

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

   • Требования к маркировке и упаковке - требования к маркировке программного изделия, варианты и способы упаковки.

   • Требования к транспортированию и хранению - транспортирования, места хранения, условия хранения, условия складирования, сроки хранения в различных условиях.

   • Специальные требования.

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

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

7. Стадии и этапы разработки - стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены), а также, как правило, сроки разработки и состав исполнителей.

8. Порядок контроля и приемки - виды испытаний и общие требования к приемке работы.

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

9. В приложениях к техническому заданию, при необходимости, приводят:

• перечень научно-исследовательских и других работ, обосновывающих разработку;

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

• другие источники разработки.

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

Стадии разработки	Этапы работ	Содержание работ
Техническое задание	Обоснование необходимости разработки программы	Постановка задачи. Сбор исходных материалов. Выбор и обоснование критериев эффективности и качества разрабатываемой программы. Обоснование необходимости проведения научно-исследовательских работ.
	Научно-исследователь-ские работы	Определение структуры входных и выходных данных. Предварительный выбор методов решения задач. Обоснование целесообразности применения ранее разработанных программ. Определение требований к техническим средствам. Обоснование принципиальной возможности решения поставленной задачи.
	Разработка и утверждение технического задания	Определение требований к программе. Разработка технико-экономического обоснования разработки программы. Определение стадий, этапов и сроков разработки программы и документации на нее. Выбор языков программирования. Определение необходимости проведения научно-исследовательских работ на последующих стадиях. Согласование и утверждение технического задания.
Эскизный проект	Разработка эскизного проекта	Предварительная разработка структуры входных и выходных данных. Уточнение методов решения задачи. Разработка общего описания алгоритма решения задачи. Разработка технико-экономического обоснования.
	Утверждение эскизного проекта	Разработка пояснительной записки. Согласование и утверждение эскизного проекта.
Технический проект	Разработка технического проекта	Уточнение структуры входных и выходных данных. Разработка алгоритма решения задачи. Определение формы представления входных и выходных данных. Определение семантики и синтаксиса языка. Разработка структуры программы. Окончательное определение конфигурации технических средств.
	Утверждение технического проекта	Разработка плана мероприятий по разработке и внедрению программы. Разработка пояснительной записки. Согласование и утверждение технического проекта.
Рабочий проект	Разработка программы	Программирование и отладка программы.
	Разработка программной документации	Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77.
	Испытания программы	Разработка, согласование и утверждение программы и методики испытаний. Проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний. Корректировка программы и программной документации по результатам испытаний.
Внедрение	Подготовка и передача программы	Подготовка и передача программы и программной документации для сопровождения и (или) изготовления. Оформление и утверждение акта о передаче программы на сопровождение и (или) изготовление. Передача программы в фонд алгоритмов и программ.

Примечания:

1. Допускается исключать вторую стадию разработки, а в технически обоснованных случаях — вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании.

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