Оформление программы по госту. Оформление программы по госту (how to). Краткое представление стандартов еспд

Когда программист получает задание на разработку программы, перед ним, перед руководителем проекта и перед всей проектной группой встают вопросы:

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

Кроме упомянутых вопросов есть и многие другие.

На все эти вопросы когда-то отвечали государственные стандарты на программную документацию - комплекс стандартов 19-й серии ГОСТ ЕСПД. Но уже тогда у программистов возникало много претензий к этим стандартам. Что-то требовалось неоправданно дублировать в документации много раз, а многое не было предусмотрено, например, отражение специфики документирования программ, работающих с базой данных.

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

2. Общая характеристика состояния

Основу отечественной нормативной базы в области документирования программ составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и большая часть этого комплекса была разработана в 70- 80-е годы. На данный момент этот комплекс представляет собой систему межгосударственных стандартов стран СНГ, действующих на территории Российской Федерации на основе межгосударственного соглашения по стандартизации.

Стандарты ЕСПД охватывают ту часть документации, которая создается в процессе разработки программы, и связаны с документированием функциональных характеристик. Не стоит забывать, что стандарты ЕСПД (ГОСТ 19) носят рекомендательный характер. Впрочем, это относится и к другим стандартам в области разработки программ таким, как: ГОСТ 34, Международному стандарту ISO/IEC, и др. В соответствии с Законом РФ «О стандартизации» эти стандарты становятся обязательными только на контрактной основе – то есть при ссылке на них в договоре на разработку программы.

Говоря о состоянии ЕСПД в целом, можно констатировать, что большая часть стандартов морально устарела.

К основным недостаткам ЕСПД можно отнести:

  • ориентацию на единственную, «каскадную» модель жизненного цикла программы;
  • отсутствие четких рекомендаций по документированию характеристик качества;
  • отсутствие связей с другими действующими отечественными системами стандартов, например ЕСКД;
  • плохо выраженный подход к документированию программы, как товарной продукции;
  • отсутствие рекомендаций по внутреннему документированию, как например экранные меню, справка по работе с программой итд.;
  • отсутствие рекомендаций по составу, содержанию и оформлению документов на программу, согласованных с международными и региональными стандартами.

Из этого выходит, что ЕСПД нуждается в полном пересмотре на основе стандарта ИСО/МЭК 12207-95, (об этом стандарте далее будет расказанно более подробнее).

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

  • Стандарты комплекса ГОСТ 34 на создание и развитие автоматизированных систем.

2.1. Краткое описание имеющихся стандартов ЕСПД

Даже не смотря на свои недостатки многие стандарты ЕСПД могут с пользой применяться для документирования программ по тому что:

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

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

Стандарты ЕСПД подразделяют на группы, приведнные в таблице:

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

Обозначение стандарта ЕСПД должно состоять из:

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

Перечень документов ЕСПД:

  1. ГОСТ 19.001-77 ЕСПД. Общие положения.
  2. ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов.
  3. ГОСТ 19.102-77 ЕСПД. Стадии разработки.
  4. ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.
  5. ГОСТ 19.104-78 ЕСПД. Основные надписи.
  6. ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам.
  7. ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом.
  8. ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.
  9. ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержанию и оформлению.
  10. ГОСТ 19.301-79 ЕСПД. Порядок и методика испытаний.
  11. ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению.
  12. ГОСТ 19.402-78 ЕСПД. Описание программы.
  13. ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.
  14. ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.
  15. ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.
  16. ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.
  17. ГОСТ 19.504-79 ЕСПД. Руководство программиста.
  18. ГОСТ 19.505-79 ЕСПД. Руководство оператора.
  19. ГОСТ 19.506-79 ЕСПД. Описание языка.
  20. ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.
  21. ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.
  22. ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.
  23. ГОСТ 19.781-90. Обеспечение систем обработки информации программное.

Термины и определения

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

Первым стандартом, который можно использовать при формировании технических заданий на программирование является ГОСТ (СТ СЭВ) 19.201-78 (1626-79). ЕСПД.
(Техническое задание. Требование к содержанию и оформлению.).

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

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

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

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

Вторым стандартом является ГОСТ (СТ СЭВ) 19.101-77 (1626-79). ЕСПД.
Виды программ и программных документов).
Этот стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

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

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

Вид программного документа Содержание программного документа
Спецификация Состав программы и документации на нее
Перечень предприятий, на которых хранят подлинники программных документов
Текст программы Запись программы с необходимыми комментариями
Описание программы Сведения о логической структуре и функционировании программы
Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля
Техническое задание Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний
Пояснительная записка Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений
Эксплуатационные документы Сведения для обеспечения функционирования и эксплуатации программы

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

Вид эксплуатационного документа Содержание эксплуатационного документа
Перечень эксплуатационных документов на программу
Формуляр Основные характеристики программы, комплектность и сведения об эксплуатации программы
Описание применения Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств
Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения
Руководство программиста Сведения для эксплуатации программы
Руководство оператора Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы
Описание языка Описание синтаксиса и семантики языка
Сведения для применения тестовых и диагностических программ при обслуживании технических средств

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

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

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

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

…………………………………………………………

ГОСТ 19.102-77. ЕСПД. Стадии разработки.

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

Стадии разработки программы, этапы и содержание работ

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

Примечания:

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

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

Код страны-разработчика и код организации-разработчика присваивают в установленном порядке.

  • Регистрационный номер присваивается в порядке возрастания, начиная с 00001 до 99999, для каждой организации-разработчика.
  • Номер издания программы или номер редакции. номер документа данного вида, номер части документа присваиваются в порядке возрастания с 01 до 99. (Если документ состоит из одной части, то дефис и порядковый номер части не указывают).
  • Номер редакции спецификации и ведомости эксплуатационных документов на программу должны совпадать с номером издания этой же программы.

ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам

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

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

Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.

ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом

Программные документы оформляют:

  • на листах формата А4 (ГОСТ 2.301-68) при изготовлении документа машинописным или рукописным способом;
  • допускается оформление на листах формата А3;
  • при машинном способе выполнения документа допускаются отклонения размеров листов, соответствующих форматам А4 и А3, определяемые возможностями применяемых технических средств; на листах форматов А4 и А3, предусматриваемых выходными характеристиками устройств вывода данных, при изготовлении документа машинным способом;
  • на листах типографических форматов при изготовлении документа типографским способом.

Расположение материалов программного документа осуществляется в следующей последовательности:

Титульная часть:

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

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

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

ГОСТ 19.402-78 ЕСПД. Описание программы

Состав документа «Описание программы» в своей содержательной части может дополняться разделами и пунктами, почерпнутыми из стандартов для других описательных документов и руководств: ГОСТ 19.404-79 ЕСПД. Пояснительная записка, ГОСТ 19.502-78 ЕСПД. Описание применения, ГОСТ 19.503-79 ЕСПД. Руководство системного программиста, ГОСТ 19.504-79 ЕСПД. Руководство программиста, ГОСТ 19.505-79 ЕСПД. Руководство оператора.

Есть также группа стандартов, определяющая требования к фиксации всего набора программ и ПД, которые оформляются для передачи ПС. Они порождают лаконичные документы учетного характера и могут быть полезны для упорядочения всего хозяйства программ и ПД (ведь очень часто требуется просто навести элементарный порядок!). Есть и стандарты, определяющие правила ведения документов в «хозяйстве» ПС.

Надо также выделить

ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний, который (в адаптированном виде) может использоваться для разработки документов планирования и проведения испытательных работ по оценке готовности и качества ПС.

Наконец, последний по году принятия стандарт.

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

Он устанавливает правила выполнения схем, используемых для отображения различных видов задач обработки данных и средств их решения и полностью соответствует стандарту ИСО 5807:1985.

Наряду с ЕСПД на межгосударственном уровне действуют еще два стандарта, также относящихся к документированию ПС и принятых не так давно, как большая часть ГОСТ ЕСПД.

ГОСТ 19781-90 Обеспечение систем обработки информации программное. Термины и определения. Разработан взамен ГОСТ 19.781-83 и ГОСТ 19.004-80 и устанавливает термины и определения понятий в области программного обеспечения (ПО) систем обработки данных (СОД), применяемые во всех видах документации и литературы, входящих в сферу работ по стандартизации или использующих результаты этих работ.

ГОСТ 28388-89 Системы обработки информации. Документы на магнитных носителях данных. Порядок выполнения и обращения. Распространяется не только на программные, но и на конструкторские, технологические и другие проектные документы, выполняемые на магнитных носителях.

2.2. Стандарты комплекса ГОСТ 34

ГОСТ 34 задумывался в конце 80-х годов как всеобъемлющий комплекс взаимоувязанных межотраслевых документов. Мотивы и получившиеся результаты описаны ниже в «Особенностях» ГОСТ 34. Объектами стандартизации являются АС различных (любых!) видов и все виды их компонентов, а не только ПО и БД.

Комплекс рассчитан на взаимодействие заказчика и разработчика. Аналогично ISO12207 предусмотрено, что заказчик может разрабатывать АС для себя сам (если создаст для этого специализированное подразделение). Однако формулировки ГОСТ 34 не ориентированы на столь явное и, в известном смысле, симметричное отражение действий обеих сторон, как ISO12207. Поскольку ГОСТ 34 в основном уделяет внимание содержанию проектных документов, распределение действий между сторонами обычно делается отталкиваясь от этого содержания.

Из всех существующих и не реализованных групп документов будем основываться только на Группе 0 «Общие положения» и Группе 6 «Создание, функционирование и развитие АС» . Наиболее популярными можно считать стандарты ГОСТ 34.601-90 (Стадии создания АС), ГОСТ 34.602-89 (ТЗ на создание АС) и методические указания РД 50-34.698-90 (Требования к содержанию документов) . Стандарты предусматривают стадии и этапы выполнения работ по созданию АС, но не предусматривают сквозных процессов в явном виде.

Для общего случая разработки АС стадии и этапы ГОСТ 34 приведены в таблице:

1. ФТ – Формирование требований к АС. 1.1. Обследование объекта и обоснование необходимости создания АС;
1.2. Формирование требований пользователя к АС;
1.3. Оформление отчета о выполненной работе и заявки на разработку АС (тактико-технического задания);
2. РК – Разработка концепции АС. 2.1. Изучение объекта;
2.2. Проведение необходимых научно-исследовательских работ;
2.3. Разработка вариантов концепции АС, удовлетворяющей требованиям пользователя
2.4. Оформление отчета о выполненной работе
3. ТЗ – Техническое создание АС. 3.1. Разработка и утверждение технического задания на задание.
4. ЭП – Эскизный проект. 4.1. Разработка предварительных проектных решений по системе и ее частям;
4.2. Разработка документации на АС и ее части.
5. ТП – Технический проект. 5.1. Разработка проектных решений по системе и ее частям;
5.2. Разработка документации на АС и ее части;
5.3. Разработка и оформление документации на поставку изделий для комплектования АС и/или технических требований (технических заданий) на их разработку;
5.4. Разработка заданий на проектирование в смежных частях проекта объекта автоматизации.
6. РД – Рабочая документация. 6.1. Разработка рабочей документации на систему и ее части;
6.2. Разработка или адаптация программ.
7. ВД – Ввод в действие. 7.1. Подготовка объекта автоматизации к вводу АС в действие;
7.2. Подготовка персонала;
7.3. Комплектация АС поставляемыми изделиями (программными и техническими средствами, программно-техническими комплексами, информационными изделиями);
7.4. Строительно-монтажные работы;
7.5. Пуско-наладочные работы;
7.6. Проведение предварительных испытаний;
7.7. Проведение опытной эксплуатации;
7.8. Проведение приемочных испытаний.
8. Сп – Сопровождение АС. 8.1. Выполнение работ в соответствии с гарантийными обязательствами;
8.2. Послегарантийное обслуживание.

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

Главный мотив: разрешить проблему «вавилонской башни».

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

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

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

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

  1. Выработать одну обобщенную понятийную и терминологическую систему, общую схему разработки, общий набор документов с их содержанием и определить их как обязательные для всех АС;
  2. Определить также одну общую понятийную и терминологическую систему, обобщенный комплекс системных требований, набор критериев качества, но предоставить максимальную свободу в выборе схемы разработки, состава документов и других аспектов, наложив только минимум обязательных требований, которые позволяли бы:
    • определять уровень качества результата;
    • выбирать те конкретные методики (с их моделями ЖЦ, набором документов и др.), которые наиболее подходят к условиям разработки и соответствуют используемым Информационным Технологиям;
    • работать, таким образом, с минимальными ограничениями эффективных действий проектировщика АС.

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

Степень адаптивности формально определяется возможностями:

  • опускать стадию эскизного проектирования и объединять стадии «Технический проект» и «Рабочая документация»;
  • опускать этапы, объединять и опускать большинство документов и их разделов;
  • вводить дополнительные документы, разделы документов и работы;
  • динамически создавая т. н. ЧТЗ – частные технические задания – достаточно гибко формировать ЖЦ АС; как правило, этот прием используется на уровне крупных единиц (подсистем, комплексов), ради которых считается оправданным создавать ЧТЗ, однако нет никаких существенных оснований сильно ограничивать этот способ управления ЖЦ.

Стадии и этапы, выполняемые организациями – участниками работ по созданию АС, устанавливаются в договорах и техническом задании, что близко к подходу ISO.

Введение единой, достаточно качественно определенной терминологии, наличие достаточно разумной классификации работ, документов, видов обеспечения и др. безусловно полезно. ГОСТ 34 способствует более полной и качественной стыковке действительно разных систем, что особенно важно в условиях, когда разрабатывается все больше сложных комплексных АС, например, типа CAD-CAM, которые включают в свой состав АСУТП, АСУП, САПР-конструктора, САПР-технолога, АСНИ и др. системы.

Определено несколько важных положений, отражающих особенности АС как объекта стандартизации, например: «в общем случае АС состоит из программно-технических (ПТК), программно-методических (ПМК) комплексов и отдельных компонентов организационного, технического, программного и информационного обеспечения».

Разделение понятий ПТК и АС закрепляло принцип, по которому АС есть не «ИС с БД», но:

  • «организационно-техническая система, обеспечивающая выработку решений на основе автоматизации информационных процессов в различных сферах деятельности (управление, проектирование, производство и т. д.) или их сочетаниях» (по РД 50-680-88), что особенно актуально в аспектах бизнес-реинжиниринга;
  • «система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций» (по ГОСТ 34.003-90).

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

Степень обязательности:

прежняя полная обязательность отсутствует, материалы ГОСТ34 по сути стали методической поддержкой, причем чаще для заказчиков, имеющих в стандарте набор требований к содержанию ТЗ и проведению испытаний АС. При этом польза ГОСТ34 может многократно возрасти в случае их более гибкого использования при формировании профиля ЖЦ АС.

Ключевым документом взаимодействия сторон является ТЗ – техническое задание на создание АС. ТЗ является основным исходным документом для создания АС и его приемки, ТЗ определяет важнейшие точки взаимодействия заказчика и разработчика. При этом ТЗ разрабатывает организация-разработчик (по ГОСТ 34.602-89), но формально выдает ТЗ разработчику заказчик (по РД 50-680-88).

2.3. Государственные стандарты РФ (ГОСТ Р)

В РФ действует ряд стандартов в части документирования ПС, разработанных на основе прямого применения международных стандартов ИСО. Это? самые «свежие» по времени принятия стандарты. Некоторые из них впрямую адресованы руководителям проекта или директорам информационных служб. Вместе с тем они неоправданно мало известны в среде профессионалов. Вот их представление.

ГОСТ Р ИСО/МЭК 9294-93 Информационная технология. Руководство по управлению документированием программного обеспечения. Стандарт полностью соответствует международному стандарту ИСО/МЭК ТО 9294:1990 и устанавливает рекомендации по эффективному управлению документированием ПС для руководителей, отвечающих за их создание. Целью стандарта является оказание помощи в определении стратегии документирования ПС; выборе стандартов по документированию; выборе процедур документирования; определении необходимых ресурсов; составлении планов документирования.

ГОСТ Р ИСО/МЭК 9126-93 Информационная технология. Оценка программной продукции. Характеристики качества и руководства по их применению. Стандарт полностью соответствует международному стандарту ИСО/МЭК 9126:1991. В его контексте под характеристикой качества понимается «набор свойств (атрибутов) программной продукции, по которым ее качество описывается и оценивается». Стандарт определяет шесть комплексных характеристик, которые с минимальным дублированием описывают качество ПС (ПО, программной продукции): функциональные возможности; надежность; практичность; эффективность; сопровождаемость; мобильность. Эти характеристики образуют основу для дальнейшего уточнения и описания качества ПС.

ГОСТ Р ИСО 9127-94 Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов. Стандарт полностью соответствует международному стандарту ИСО 9127:1989. В контексте настоящего стандарта под потребительским программным пакетом (ПП) понимается «программная продукция, спроектированная и продаваемая для выполнения определенных функций; программа и соответствующая ей документация, упакованные для продажи как единое целое». Под документацией пользователя понимается документация, которая обеспечивает конечного пользователя информацией по установке и эксплуатации ПП. Под информацией на упаковке понимают информацию, воспроизводимую на внешней упаковке ПП. Ее целью является предоставление потенциальным покупателям первичных сведений о ПП.

ГОСТ Р ИСО/МЭК 8631-94 Информационная технология. Программные конструктивы и условные обозначения для их представления. Описывает представление процедурных алгоритмов.

2.4. Международный стандарт ISO/IEC 12207: 1995-08-01

Первая редакция ISO12207 подготовлена в 1995 году объединенным техническим комитетом ISO/IEC JTC1 «Информационные технологии, подкомитет SC7, проектирование программного обеспечения».

По определению, ISO12207 – базовый стандарт процессов ЖЦ ПО, ориентированный на различные (любые!) виды ПО и типы проектов АС, куда ПО входит как часть. Стандарт определяет стратегию и общий порядок в создании и эксплуатации ПО, он охватывает ЖЦ ПО от концептуализации идей до завершения ЖЦ.

Очень важные ЗАМЕЧАНИЯ СТАНДАРТА:

  1. Процессы, используемые во время ЖЦ ПО, должны быть совместимы с процессами, используемыми во время ЖЦ АС. (Отсюда понятна целесообразность совместного использования стандартов на АС и на ПО.)
  2. Добавление уникальных или специфических процессов, действий и задач должно быть оговорено в контракте между сторонами. Контракт понимается в широком смысле: от юридически оформленного контракта до неформального соглашения, соглашение может быть определено и единственной стороной как задача, поставленная самому себе.
  3. Стандарт принципиально не содержит конкретные методы действий, тем более – заготовки решений или документации. Он описывает архитектуру процессов ЖЦ ПО, но не конкретизирует в деталях, как реализовать или выполнить услуги и задачи, включенные в процессы, не предназначен для предписывания имени, формата или точного содержимого получаемой документации. Решения такого типа принимаются использующим стандарт.

ОПРЕДЕЛЕНИЯ СТАНДАРТА:

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

Стандарт не предписывает конкретную модель ЖЦ или метод разработки ПО, но определяет, что стороны-участники использования стандарта ответственны за выбор модели ЖЦ для проекта ПО, за адаптацию процессов и задач стандарта к этой модели, за выбор и применение методов разработки ПО, за выполнение действий и задач, подходящих для проекта ПО.

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

Каждый процесс ЖЦ разделен на набор действий, каждое действие – на набор задач. Очень важное отличие ISO: каждый процесс, действие или задача инициируется и выполняется другим процессом по мере необходимости, причем нет заранее определенных последовательностей (естественно, при сохранении логики связей по исходным сведениям задач и т. п.).

В стандарте ISO12207 описаны:

  1. 5 основных процессов ЖЦ ПО:
    • Процесс приобретения. Определяет действия предприятия-покупателя, которое приобретает АС, программный продукт или сервис ПО.
    • Процесс поставки. Определяет действия предприятия-поставщика, которое снабжает покупателя системой, программным продуктом или сервисом ПО.
    • Процесс разработки. Определяет действия предприятия-разработчика, которое разрабатывает принцип построения программного изделия и программный продукт.
    • Процесс функционирования. Определяет действия предприятия-оператора, которое обеспечивает обслуживание системы (а не только ПО) в процессе ее функционирования в интересах пользователей. В отличие от действий, которые определяются разработчиком в инструкциях по эксплуатации (эта деятельность разработчика предусмотрена во всех трех рассматриваемых стандартах), определяются действия оператора по консультированию пользователей, получению обратной связи и др., которые он планирует сам и берет на себя соответствующе обязанности.
    • Процесс сопровождения. Определяет действия персонала сопровождения, который обеспечивает сопровождение программного продукта, что представляет собой управление модификациями программного продукта, поддержку его текущего состояния и функциональной пригодности, включает в себя инсталляцию и удаление программного изделия на вычислительной системе.
  2. 8 вспомогательных процессов, которые поддерживают реализацию другого процесса, будучи неотъемлемой частью всего ЖЦ программного изделия, и обеспечивают должное качество проекта ПО:
    • решения проблем;
    • документирования;
    • управления конфигурацией;
    • гарантирования качества, который использует результаты остальных процессов группы обеспечения качества, в которую входят:
      • Процесс верификации;
      • Процесс аттестации;
      • Процесс совместной оценки;
      • Процесс аудита.
  3. 4 организационных процесса:
    • Процесс управления;
    • Процесс создания инфраструктуры;
    • Процесс усовершенствования;
    • Процесс обучения.

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

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

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

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

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

Такой характер позволяет реализовывать любую модель ЖЦ.

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

При этом разработчик должен установить и документировать как требования к программному обеспечению:

  1. Функциональные и возможные спецификации, включая исполнение, физические характеристики и условия среды эксплуатации, при которых единица программного обеспечения должна быть выполнена;
  2. Внешние связи (интерфейсы) с единицей программного обеспечения;
  3. Требования квалификации;
  4. Спецификации надежности, включая спецификации, связанные с методами функционирования и сопровождения, воздействия окружающей среды и вероятностью травмы персонала;
  5. Спецификации защищенности,
  6. Человеческие факторы спецификаций по инженерной психологии (эргономике), включая связанные с ручным управлением, взаимодействием человека и оборудования, ограничениями на персонал и областями, нуждающимися в концентрированном человеческом внимании, которые являются чувствительными к ошибкам человека и обучению;
  7. Определение данных и требований базы данных;
  8. Установочные и приемочные требования поставляемого программного продукта в местах функционирования и сопровождения (эксплуатации);
  9. Документация пользователя;
  10. Работа пользователя и требования выполнения;
  11. Требования сервиса пользователя.
  1. (Интересно и важно, что эти и аналогичные характеристики хорошо корреспондируются с характеристиками АС, предусматриваемыми в ГОСТ 34 по видам обеспечения системы.)

Стандарт содержит предельно мало описаний, направленных на проектирование БД. Это можно считать оправданным, так как разные системы и разные прикладные комплексы ПО могут не только использовать весьма специфические типы БД, но и не использовать

Итак, ISO12207 имеет набор процессов, действий и задач, охватывающий наиболее широкий спектр возможных ситуаций при максимальной адаптируемости.

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

По этой причине центральным стандартом, положения которого берутся за начальный «стержневой» набор положений в процессе построения профиля стандартов ЖЦ для конкретного проекта, полезно рассматривать именно ISO12207. Этот «стержень» может задавать модель ЖЦ ПО и АС, принципиальную схему гарантирования качества, модель управления проектом

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

В настоящее время во ВНИИ стандартов подготовлены предложения по совершенствованию и развитию комплекса стандартов по документированию ПС.

Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р

Система технической документации на АСУ

ГОСТ 24.207-80

ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ ПО ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ

System of technical documentation for computer control systems. Requirements for contents of documents on software

Постановлением Государственного комитета СССР по стандартам от 14 мая 1980 г. № 2101 срок введения установлен

с 01.01 1981 г.

Настоящий стандарт распространяется на техническую документацию на автоматизированные системы управления (АСУ) всех видов, разрабатываемые для всех уровней управления (кроме общегосударственного), и устанавливает требования к содержанию документов, входящих в соответствии с ГОСТ 24.101-80 в состав документации программного обеспечения в проектах АСУ.

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Документация программного обеспечения предназначена:

  • для описания проектных решений по программному обеспечению в документе «Описание программного обеспечения АСУ».
  • для установления требований к программе (комплексу программ) в документе «Техническое задание»;
  • для описания решений, обеспечивающих сопровождение, изготовление и эксплуатацию программы (комплекса программ) в документах «Пояснительная записка», «Описание применения», «Описание программы», «Спецификация», «Руководство программиста», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний»;
  • для проверки работоспособности программы (комплекса программ) в документе «Описание контрольного примера».

1.2. При разработке документов на части АСУ содержание разделов каждого документа ограничивают рамками соответствующей части.

1.3. В зависимости от назначения и специфических особенностей создаваемых АСУ допускается включать в документы дополнительные разделы, требования к содержанию которых не установлены настоящим стандартом. Отсутствие проектных решений по разделу документа фиксируют в соответствующем разделе с необходимыми пояснениями.

1.4. Требования к содержанию документов «Техническое задание», «Пояснительная записка», «Описание применения», «Спецификация», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний» установлены ГОСТ 19.201-78 , ГОСТ 19.404-79 , ГОСТ 19.502-78 , ГОСТ 19.202-78 , ГОСТ 19.505-79 , ГОСТ 19.401-78 , ГОСТ 19.501-78 и ГОСТ 19.301-79 .

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

2. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ

2.1. Описание программного обеспечения АСУ

2.1.1. Документ должен содержать вводную часть и разделы:

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

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

2.1.3. Раздел «Структура программного обеспечения» должен содержать перечень частей программного обеспечения с указанием их взаимосвязей и обоснованием выделения каждой из них.

2.1.4. Раздел «Основные функции частей программного обеспечения» должен содержать подразделы, в которых для каждой части программного обеспечения приводят назначение и описание основных функций

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

2.1.5. Раздел «Методы и средства разработки программного обеспечения» должен содержать перечень методов программирования и средств разработки программного обеспечения АСУ с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.

2.1.6. Раздел «Операционная система» должен содержать:

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

2.1.7. Раздел «Средства, расширяющие возможности операционной системы» должен содержать подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, следует указать:

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

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

2.2.2. Для программы (комплекса программ), получаемой за счет использования ранее разработанных программных средств, документ «Описание программы» следует дополнять разделом «Настройка программных средств».

2.2.3. Раздел «Настройка программных средств» должен содержать:

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

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

2.3.1. Документ по составу разделов и их содержанию должен соответствовать ГОСТ 19.504-79 и, кроме того, включать раздел «Сведения о форме представления программы (комплекса программ)».

2.3.2. Раздел «Сведения о форме представления программы (комплекса программ)» должен содержать сведения о носителе, на котором записана программа, о содержании и системе кодирования информации, записанной на носителе, а также сведения, необходимые для чтения информации с носителя.

2.3.3. Для программы (комплекса программ), допускающей настройку на условия конкретного применения, в документ «Руководство программиста» включают разделы:

2.3.4. Разрешается для программы (комплекса программ), допускающей настройку на условия конкретного применения, вместо разделов, перечисленных в п. 2.3.3, разрабатывать отдельный документ «Руководство системного программиста», удовлетворяющий требованиям ГОСТ 19.503-79 .

2.4. Описание контрольного примера

2.4.1. Документ должен содержать разделы:

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

2.4.2. Раздел «Назначение» должен содержать перечень параметров и краткую характеристику функции, из числа реализуемых программой (комплексом программ), проверяемых контрольным примером.

2.4.3. Раздел «Исходные данные» должен содержать описание исходных данных для проверки программы (комплекса программ) с приведением исходных данных. Допускается исходные данные представлять в виде распечатки с АЦПУ.

2.4.4. Раздел «Результаты расчета» должен содержать результаты обработки исходных данных программой (комплексом программ), позволяющие оценить правильность выполнения проверяемых функции и значение проверяемых параметров. Допускается результаты расчета приводить в виде распечатки с АЦПУ.

2.4.5. Раздел «Проверка программы (комплекса программ)» должен содержать:

  • описание состава технических средств, необходимых для работы программы (комплекса программ), или ссылку на соответствующие программные документы;
  • описание процедур формирования исходных данных для проверки программы (комплекса программ), вызова проверяемой программы (комплекса программ) и получения результатов расчета;
  • описание действий оператора при подготовке исходных данных и проверке программы (комплекса программ) на контрольном примере.
* Переиздание (май 1986 г.) с Изменением № 1, утвержденным в августе 1985 г. (ИУС 11-85).

Наименование:

Единая система программной документации.

Действует

Дата введения:

Дата отмены:

Заменен на:

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

ГОСТ 19.101-77

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ

ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ

Издание официальное

Стандартинформ

УДК 002:651.7/.78:006.354

Группа Т55

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ

Unified system for program documentation.

Types of programs and program documents

Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. № 1268 дата введения установлена

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

Стандарт полностью соответствует СТ СЭВ 1626-79.

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

1. ВИДЫ ПРОГРАММ

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

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

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

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

2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ

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

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

Издание официальное ★

Перепечатка воспрещена

) Издательство стандартов, 1977 © СТАНДАРТИНФОРМ, 2010

Издание (январь 2010 г.) с Изменением № 1, утвержденным в июне 1981 г. (ИУС 9-81).

Таблица 2

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

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

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

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

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

ных документов

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Таблица 3

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Таблица 4

Код вида документа

Вид документа

Стадии разработки

Эскизный

Технический

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

компонент

комплекс

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

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

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

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

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

документов

Формуляр

Продолжение таблицы 4

Код вида документа

Стадии разработки

Вид документа

Эскизный

Технический

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

компонент

комплекс

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

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

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

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

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

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

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

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

Прочие документы

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

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

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

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

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

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

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

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

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

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

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

(Введен дополнительно, Изм. № 1).

  • ГОСТ 19.001-77 Единая система программной документации. Общие положения
  • ГОСТ 19.005-85 Единая система программной документации. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения
  • ГОСТ 19.101-77 Единая система программной документации. Виды программ и программных документов
  • ГОСТ 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.403-79 Единая система программной документации. Ведомость держателей подлинников
  • ГОСТ 19.404-79 Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению
  • ГОСТ 19.501-78 Единая система программной документации. Формуляр. Требования к содержанию и оформлению
  • ГОСТ 19.502-78 Единая система программной документации. Описание применения. Требования к содержанию и оформлению
  • ГОСТ 19.503-79 Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению
  • ГОСТ 19.504-79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению
  • ГОСТ 19.505-79 Единая система программной документации. Руководство оператора. Требования к содержанию и оформлению
  • ГОСТ 19.506-79 Единая система программной документации. Описание языка. Требования к содержанию и оформлению
  • ГОСТ 19.507-79 Единая система программной документации. Ведомость эксплуатационных документов
  • ГОСТ 19.508-79 Единая система программной документации. Руководство по техническому обслуживанию. Требования к содержанию и оформлению
  • ГОСТ 19.601-78 Единая система программной документации. Общие правила дублирования, учета и хранения
  • ГОСТ 19.602-78 Единая система программной документации. Правила дублирования, учета и хранения программных документов, выполненных печатным способом
  • ГОСТ 19.603-78 Единая система программной документации. Общие правила внесения изменений
  • ГОСТ 19.604-78 Единая система программной документации. Правила внесения изменений в программные документы, выполненные печатным способом
  • ГОСТ 28195-89 Оценка качества программных средств. Общие положения
  • ГОСТ 34.601-90 Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания
  • ГОСТ 34.602-89 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы
  • ГОСТ Р 56447-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для обработки и интерпретации данных сейсморазведки. Основные функциональные и технические требования
  • ГОСТ Р 56448-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для геологического моделирования месторождений. Основные функциональные и технические требования
  • ГОСТ Р 56450-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для гидродинамического моделирования систем сбора и подготовки углеводородов. Основные функциональные и технические требования
  • ГОСТ Р 55711-2013 Комплекс технических средств автоматизированной адаптивной ВЧ (КВ) дуплексной радиосвязи. Алгоритмы работы
  • ГОСТ Р 56566-2015 Информационные технологии. Оценка процессов. Часть 9. Профили целевого процесса
  • ГОСТ Р 55692-2013 Модули электронные. Методы составления и отладки тест-программ для автоматизированного контроля
  • ГОСТ Р 56449-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для гидродинамического моделирования месторождений. Основные функциональные и технические требования
  • ГОСТ Р 56413-2015 Информационные технологии. Европейские профили профессий ИКТ-сектора
  • ГОСТ Р ИСО/МЭК 15026-1-2016 Системная и программная инженерия. Гарантирование систем и программного обеспечения. Часть 1. Понятия и словарь
  • ГОСТ Р ИСО/МЭК 15026-4-2016 Системная и программная инженерия. Гарантирование систем и программного обеспечения. Часть 4. Гарантии жизненного цикла
  • ГОСТ Р 56920-2016 Системная и программная инженерия. Тестирование программного обеспечения. Часть 1. Понятия и определения
  • ГОСТ Р 56921-2016 Системная и программная инженерия. Тестирование программного обеспечения. Часть 2. Процессы тестирования
  • ГОСТ Р ИСО/МЭК 26555-2016 Системная и программная инженерия. Инструменты и методы технического менеджмента линейки продуктов
  • ГОСТ Р ИСО/МЭК 29155-1-2016 Системная и программная инженерия. Структура сопоставительного анализа эффективности выполнения проектов информационных технологий. Часть 1. Понятия и определения
  • ГОСТ Р 54360-2011 Лабораторные информационные менеджмент-системы (ЛИМС). Стандартное руководство по валидации ЛИМС
  • ГОСТ Р 54593-2011 Информационные технологии. Свободное программное обеспечение. Общие положения
  • ГОСТ Р ИСО/МЭК 12207-2010 Информационная технология. Системная и программная инженерия. Процессы жизненного цикла программных средств
  • ГОСТ Р 53798-2010 Стандартное руководство по лабораторным информационным менеджмент-системам (ЛИМС)
  • ГОСТ Р ИСО/МЭК 15504-1-2009 Информационные технологии. Оценка процессов. Часть 1. Концепция и словарь
  • ГОСТ Р ИСО/МЭК 15504-2-2009 Информационная технология. Оценка процесса. Часть 2. Проведение оценки
  • ГОСТ Р ИСО/МЭК 15504-3-2009 Информационная технология. Оценка процесса. Часть 3. Руководство по проведению оценки
  • ГОСТ Р 57098-2016 Системная и программная инженерия. Управление жизненным циклом. Руководство для описания процесса
  • ГОСТ Р 57100-2016 Системная и программная инженерия. Описание архитектуры
  • ГОСТ Р 57101-2016 Системная и программная инженерия. Процессы жизненного цикла. Управление проектом
  • ГОСТ Р 57102-2016 Информационные технологии. Системная и программная инженерия. Управление жизненным циклом. Часть 2. Руководство по применению ИСО/МЭК 15288
  • ГОСТ Р 57122-2016 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для проектирования строительства скважин. Основные функциональные и технические требования
  • ГОСТ Р 57193-2016 Системная и программная инженерия. Процессы жизненного цикла систем
  • ГОСТ Р ИСО/МЭК 15504-5-2016 Информационные технологии. Оценка процессов. Часть 5. Образец модели оценки процессов жизненного цикла программного обеспечения
  • ГОСТ 34009-2016 Средства и системы управления железнодорожным тяговым подвижным составом. Требования к программному обеспечению
  • ГОСТ Р 57318-2016 Системы промышленной автоматизации и интеграция. Применение и управление процессами системной инженерии
  • ГОСТ Р ИСО/МЭК 25001-2017 Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Планирование и управление
  • ГОСТ Р ИСО/МЭК 33004-2017 Информационные технологии. Оценка процесса. Требования к эталонным моделям процесса, моделям оценки процесса и моделям зрелости
  • ГОСТ Р ИСО/МЭК 15414-2017 Информационные технологии. Открытая распределенная обработка. Эталонная модель. Язык описания предприятия
  • ГОСТ IEC 60848-2016 Язык спецификаций GRAFCET для последовательных функциональных схем
  • ГОСТ Р ИСО/МЭК 25051-2017 Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Требования к качеству готового к использованию программного продукта (RUSP) и инструкции по тестированию
  • ГОСТ Р ИСО/МЭК 33001-2017 Информационные технологии. Оценка процесса. Понятия и терминология
  • ГОСТ Р ИСО/МЭК 33002-2017 Информационные технологии. Оценка процесса. Требования к проведению оценки процесса
  • ГОСТ Р ИСО/МЭК 33003-2017 Информационные технологии. Оценка процесса. Требования к системам измерения процесса
  • ГОСТ Р ИСО/МЭК 33020-2017 Информационные технологии. Оценка процесса. Система измерения процесса для оценки возможностей процесса
  • ГОСТ Р 57640-2017 Информационные технологии. Эталонная модель процесса (ЭМП) для управления информационной безопасностью
  • ГОСТ Р ИСО/МЭК 30121-2017 Информационные технологии. Концепция управления рисками, связанными с проведением судебной экспертизы свидетельств, представленных в цифровой форме
  • ГОСТ Р 58041-2017 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Система стандартов по программному обеспечению для решения задач поиска, разведки и разработки месторождений. Основные положения и технические требования
  • ГОСТ Р 58042-2017 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Основные требования к исходным данным программных комплексов для решения задач поиска, разведки и разработки месторождений
  • ГОСТ Р ИСО/МЭК 10746-1-2004 Информационная технология. Открытая распределенная обработка. Базовая модель. Часть 1. Основные положения
  • ГОСТ Р ИСО/МЭК 10746-4-2004 Информационная технология. Открытая распределенная обработка. Базовая модель. Часть 4. Архитектурная семантика
  • ГОСТ Р ИСО/МЭК 12119-2000 Информационная технология. Пакеты программ. Требования к качеству и тестирование
  • ГОСТ Р ИСО/МЭК 12207-99 Информационная технология. Процессы жизненного цикла программных средств
  • ГОСТ Р ИСО/МЭК 14764-2002 Информационная технология. Сопровождение программных средств

ГОСТ 19.101-77

Группа Т55

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ

Unified system for program documentation. Types of programs and program documents

МКС 35.080

Дата введения 1980-01-01


Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. N 1268 дата введения установлена 01.01.80

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в июне 1981 г. (ИУС 9-81).


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

Стандарт полностью соответствует СТ СЭВ 1626-79.

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

1. ВИДЫ ПРОГРАММ

1. ВИДЫ ПРОГРАММ

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

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

Таблица 1

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

Определение

Компонент

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

Комплекс

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

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

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

2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ

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

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

Таблица 2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Таблица 3

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

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

Формуляр

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

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

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

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

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

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

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

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

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

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

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

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

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

Таблица 4

Код
вида документа

Вид документа

Стадии разработки

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

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

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

компонент

комплекс

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

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

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

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

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

Формуляр

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

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

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

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

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

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

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

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

Прочие документы


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

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

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

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

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

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

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

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

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

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

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

(Введен дополнительно, Изм. N 1).



Электронный текст документа
подготовлен АО "Кодекс" и сверен по:
официальное издание
Единая система программной
документации: Сб. ГОСТов. -
М.: Стандартинформ, 2010

Правила оформления и требования к содержанию курсовых

Редакция 2

проектов (работ) и выпускных квалификационных работ

стр. 39 из 73

Сборочный чертёж сборочной единицы

под номером 8, входящей в изделие 1

ПК.760108.000 СБ

Сборочный чертёж отдельной сборочной

единицы 4

ПК.760004.000 СБ

Чертёж общего вида отдельной сборочной

единицы 4

ПК.760004.000 ВО

Чертёж детали под номером 16, входящей в

сборочную единицу 8 изделия 1

Чертёж детали под номером 120, входящей в

отдельную сборочную единицу 4

Схема электрическая принципиальная изделия 1

ПК.760100.000 Э3

Схема кинематическая принципиальная отдель-

ной сборочной единицы 4

ПК.760400.000 К3

Спецификация сборочной единицы 8 изделия 1

10 Оформление технологических документов

10.1 Технологические документы курсовых проектов (работ) и выпускных квалификационных работ оформляются в соответствии с требованиями стандартов ЕСТД.

10.2 Технологические документы должны включать:

титульный лист, оформленный в соответствии с ГОСТ 3.1105-84 «ЕСТД. Форма и правила оформления документов общего назначения» (форма 2а).

маршрутную карту, оформленную по ГОСТ 3.1118-82 «ЕСТД. Формы и правила оформления маршрутных карт»;

операционные карты механической обработки и операционные

расчётно-технологические карты на технологические операции, на станках с ЧПУ − по ГОСТ 3.1404-86 «ЕСТД. Формы и правила оформления документов на технологические процессы и операции обработки резанием»;

операционные карты слесарных, слесарно-сборочных работ по ГОСТ 3.1407-86 «ЕСТД. Формы и требования к заполнению и оформлению документов на технологические процессы (операции), специализированные по методам сборки»;

карты эскизов (в случае необходимости) по ГОСТ 3.1105-84 и ГОСТ 3.1128-93 «ЕСТД. Общие правила выполнения графических технологических документов»;

операционные карты технологического контроля по ГОСТ 3.1502-85 «ЕСТД. Формы и правила оформления документов на технический контроль»;

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

10.3 Ремонтные чертежи выполняются в соответствии с правилами, предусмотренными ГОСТ 2.604-88 «Чертежи ремонтные».

10.4 Технологические документы должны быть сброшюрованы

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

11 Оформление программных документов

11.1 Разработанные в курсовых проектах (работах) и выпускных квалификационных работах документы различных проблемных областей должны быть оформлены следующим образом:

программные документы – в соответствии с требованиями ЕСПД,

документы для автоматизированной системы управления – по государственным стандартам системы технологической документации на АСУ. 11.2 Программные документы (листинги программ) должны включать:

текст программы, оформленный согласно ГОСТ 19.401;

описание программы, выполненное согласно ГОСТ 19.402;

описание примечания, приведённое согласно ГОСТ 19.502;

другие программные документы (при необходимости).

11.3 Листинги программ размещаются в приложениях с обязательными ссылками на них в ПЗ.

11.4 Программный код может быть сопровождён комментариями. При оформлении листингов рекомендуется использовать шрифт Courier New, размер – 12 пт, межстрочный интервал – одинарный. Рекомендуется отделять смысловые блоки пустыми строками, а также визуально обозначать вложенные конструкции с помощью отступов.

11.5 Ключевые слова и комментарии в листинге программ могут быть выделены с помощью курсива. В основном тексте ПЗ курсивом следует выделять имена библиотек, подпрограммы, константы, переменные и т.д.

11.6 Листинги программ должны иметь порядковую нумерацию в пределах приложения. Номер листинга должен состоять из обозначения приложения и порядкового номера листинга, разделенных точкой, например: «Листинг А.3» – третий листинг приложения А. Если в проекте (работе) содержится только один листинг, он обозначается «Листинг 1». При ссылке на листинг в тексте ПЗ следует писать слово «Листинг» с указанием его номера.

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

Пример оформления листинга программы Листинг А.3 – Программа « Вывод двумерного массива»

mas:array of integer; {объявление двухмерного массива } i,j:integer;

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1

{ Ввод значений элементов массива} for i:=1 to 5 do

for j:=1 to 5 do readln(mas);

{Вывод значений элементов массива} for i:=1 to 5 do begin

for j:=1 to 5 do write(" ",mas); writeln;

12 Нормоконтроль

12.1 Нормоконтроль является завершающим этапом разработки документов курсового проекта (работы) и ВКР.

12.2 Нормоконтроль должен соответствовать требованиям ГОСТ 2.111.

12.3 Нормоконтролю подлежат выпускные квалификационные работы. Нормоконтроль курсовых проектов (работ) проводится преподавателем при защите работы. Проведение нормоконтроля направлено на правильность выполнения текстовых и графических документов курсовых проектов (работ) и ВКР (далее документов) в соответствии с требованиями ГОСТ, стандартов ЕСКД, ЕСПД и ЕСТД.

12.4 Нормоконтроль выполняется нормоконтролёром с учётом требований, действующих на данный момент, стандартов и нормативно-технических документов.

12.5 В процессе нормоконтроля пояснительных записок курсовых проектов (работ) и ВКР проверяется:

– соблюдение правил оформления согласно настоящему Положению;

внешний вид ПЗ;

– комплектность ПЗ в соответствии с заданием на проектирование;

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

– правильность заполнения ведомости проекта (работы);

– наличие и правильность рамок, основных надписей на всех страницах;

– выделение заголовков, разделов и подразделов, наличие красных строк;

– правильность оформления содержания, соответствие названий разделов и подразделов в содержании соответствующим названиям в тексте записки;

– правильность нумерации страниц, разделов, подразделов, рисунков, таблиц, формул;

– правильность оформления рисунков;

– правильность оформления таблиц;

– правильность размерностей физических величин, их соответствие СИ;

– соответствие нормам современного русского языка;

– правильность примененных сокращений слов;

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1

наличие и правильность ссылок на используемые источники;

наличие и правильность ссылок на нормативные документы;

правильность оформления списка использованных источников;

правильность оформления приложений.

12.6 В процессе нормоконтроля графических документов курсовых проектов (работ) и ВКР проверяется:

соответствие оформления чертежей требованиям действующих стандартов;

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

соблюдение форматов, правильность их оформления;

правильность начертания и применения линий;

соблюдение масштабов, правильность их обозначения;

достаточность изображений (видов, разрезов, сечений), правильность их обозначения и расположения;

соблюдение условных обозначений элементов в схемах и правил их выполнения в соответствии с требованиями ЕСКД.

12.7. Нормоконтроль выпускных квалификационных работ рекомендуется проводить в два этапа: после черновой (или в тонких линиях) и окончательной разработки оригиналов документов. Разрабатываемые документы должны предъявляться на нормоконтроль комплектно, т.е. текстовая (пояснительная записка) и графическая документация (чертежи, спецификации и т.п.).

12.8 Перечень замечаний нормоконтролёра составляется в том случае, если контроль проводится в отсутствие студента-разработчика и сущность ошибок может быть им неправильно истолкована.

12.9 Проверенные нормоконтролёром в присутствии студента-разработчика документы вместе с перечнем замечаний (если он составляется) возвращаются студенту для внесения исправлений и переработки. Если замечания существуют, пометки нормоконтролёра сохраняются до подписания им документа. Если документ заново перерабатывается студентом, то на повторный контроль сдаются оба экземпляра: с пометками нормоконтролера и переработанный.

12.10 Предъявляемые на подпись нормоконтролёру документы должны иметь все визы согласования, кроме визы заведующего кафедрой. Чистовые оригиналы курсовых и дипломных проектов (работ) нормоконтролёр подписывает

в графе «Н.контр.» основной надписи.

12.11 Запрещается без ведома нормоконтролёра вносить какие-либо изменения в документ после того, как этот документ подписан и завизирован нормоконтролёром.

12.12 Нормоконтролёр имеет право в обоснованных случаях не подписывать предоставленный документ:

– при невыполнении требований нормативных документов;

– при отсутствии обязательных подписей;

– при небрежном выполнении;

– при нарушении установленной комплектности.

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1

12.13 Нормоконтролёр несёт ответственность за соблюдение в разрабатываемой документации требований действующих стандартов и других нормативно-технических документов наравне с разработчиками документации.

13 Рецензирование ВКР

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

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

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

13.3 Рецензент должен быть ознакомлен со всеми требованиями, предъявляемыми к выпускной квалификационной работе (ВКР).

13.4 Рецензия оформляется в письменном виде и содержит аргументированные оценки:

– актуальности темы ВКР;

– соответствии содержания ВКР заданию на его разработку;

– правильности логической структуры ВКР;

– эффективности и обоснованности проектных решений;

– достоинства и недостатков ВКР, соответствие ее квалификационным требованиям выпускника по направлению подготовки;

– оформления ВКР.

В заключительной части рецензии даются выводы о полноте разработки темы, в соответствие с поставленными задачами, о теоретическом или практическом значении ВКР, о возможной области использования результатов ВКР. Рецензент оценивает работу по четырёхбалльной шкале («отлично», «хорошо», «удовлетворительно», «неудовлетворительно») и указывает возможность присвоения студенту должной квалификации.

13.5 Объем рецензии на выпускную квалификационную работу должен составлять 2-3 страницы печатного или четко написанного от руки текста. Подписанная рецензия должна быть представлена на кафедру, не позднее, чем за три дня до защиты ВКР.

13.6 Рецензия может быть выполнена на фирменном бланке организации (место работы рецензента), либо на бланке установленной формы, регламентированной настоящими Правилами (приложение У) и заверена печатью организации, либо печатью отдела кадров (общего отдела, канцелярии) с отметкой «подпись верна».

13.7 На защиту ВКР в комиссию по государственной аттестации можно дополнительно представить отзыв ведущей организации, по заказу которой

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1

выполнялась ВКР. В отзыве должна быть отмечена практическая ценность полученных результатов.

14 Отзыв на ВКР

14.1 Отзыв на выпускную квалификационную работу составляется непосредственно ее руководителем. Отзыв должен характеризовать ВКР с разных сторон: со стороны содержания, структуры, полноты раскрытия выбранной темы и т.д.

14.2 Руководитель должен изложить в отзыве свое объективное мнение о выпускной квалификационной работе студента. В частности, отзыв должен содержать сведения:

– об актуальности темы работы;

– о соответствии выпускной квалификационной работы требованиям, предъявляемым стандартами;

– о владении студентом методами сбора, обработки и анализа информации применяемой в сфере профессиональной деятельности;

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

– о положительных сторонах работы;

– о недостатках и замечаниях по содержанию работы и др.

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

14.4 В заключении отзыва, руководитель делает вывод о возможности представления к защите выпускной квалификационной работы к защите в ГАК.

14.5 Текст отзыва руководителя на ВКР печатается на листах формата А4 и подписывается научным руководителем. Форма отзыва на ВКР представлена в приложении Ф.

15 Доклад и презентация

15.1 Доклад (выступление) – это работа презентативного характера, отражающая суть ВКР.

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

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

15.2 Доклад рассчитан на заданное ограниченное время выступления и неразрывно связан с презентацией (раздаточным материалом).

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1

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

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

Материал должен иллюстрировать все тезисы, выведенные в докладе.

15.5 Показ презентации может быть осуществлен двумя способами:

с помощью проектора и на стенде;

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

Объём презентации может быть от 8 до 12 слайдов.

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

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

в 1-2 предложениях рассмотреть рекомендации для решения поставленных проблем.

15.7 Первым должен быть слайд с темой проекта (работы) и данными исполнителя, то есть: фамилия, имя, отчество, группа, специальность (направление). Желательно указать научного руководителя.

15.8 Курсовой проект (работа) и ВКР сдаются в архив вместе с презентацией, выполненной в электронном виде и записанной на цифровом носитель (например, CD/DVD-диск).

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1

Приложение А

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1

Приложение Б

(наименование факультета)

(наименование кафедры)

____________ ________________

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА

к курсовому проекту (работе) по дисциплине (модулю)__

(наименование учебной дисциплины (модуля))

на тему _________________________________________________________________________

_____

_______________________

______________________________

Направление/специальность, профиль/специализация:

___________ _________________________________________________________________

код направления наименование направления (специальности)

________________________________________________________________________________

наименование профиля (специализации)

Обозначение курсового проекта (работы) _________________________ Группа ________

Ростов-на-Дону

Приложение В

МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РОССИЙСКОЙ ФЕДЕРАЦИИ

ФЕДЕРАЛЬНОЕ ГОСУДАРСТВЕННОЕ БЮДЖЕТНОЕ ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ ВЫСШЕГО ПРОФЕССИОНАЛЬНОГО ОБРАЗОВАНИЯ

«ДОНСКОЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ» (ДГТУ)

Факультет _______________________________________________________

(наименование факультета)

Кафедра _________________________________________________________

(наименование кафедры)

Зав. кафедрой «______________»

____________ ________________

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА

к дипломному проекту (работе) на тему:

___________________________________________________________________________

___________________________________________________________________________

___________________________________________________________________________

__________________________

(подпись, дата)

Обозначение дипломного проекта ______________________

Группа ______________

Направление (специальность) ___________

___________________________________

(наименование)

Руководитель проекта (работы)

____________________________

(подпись, дата)

(должность, И.О.Ф.)

Консультанты по разделам:

_______________________________

_____________________

(наименование раздела)

(подпись, дата)

(должность, И.О.Ф.)

_______________________________

_____________________

(наименование раздела)

(подпись, дата)

(должность, И.О.Ф.)

Нормоконтроль

_____________________

(подпись, дата)

(должность, И.О.Ф.)

Ростов-на-Дону

Правила оформления и требования к содержанию курсовых проектов (работ) и выпускных квалификационных работ – 09.1