- •Южно-Российский государственный технический университет (Новочеркасский политехнический институт)
- •Список сокращений
- •Введение
- •Единая система конструкторской документации
- •Единая система программной документации
- •Другие стандарты
- •Техническое задание (гост 19.201-78 еспд)
- •Текст программы (гост 19.401-78 еспд)
- •Описание программы (гост 19.402-78 еспд)
- •Графические материалы (гост 19.701-90 еспд)
- •Графические символы и их применение
- •Продолжение табл. 7.2
- •Библиографический список
Единая система конструкторской документации
Единая система конструкторской документации – комплекс стандартов, устанавливающих взаимосвязанные нормы и правила по разработке, оформлению и обращению конструкторской документации, разрабатываемой и применяемой на всех стадиях жизненного цикла изделия (при проектировании, изготовлении, эксплуатации, ремонте и др.).
Установленные стандартами ЕСКД нормы и правила по разработке, оформлению и обращению документации распространяются на программную документацию в той части, в которой они могут быть для неё применимы и не регламентируются другими стандартами и нормативами.
Единая система программной документации
Основу отечественной нормативной базы в области документирования программных систем (ПС) составляет комплекс стандартов Единой системы программной документации. Основная и большая часть комплекса ЕСПД была разработана в 70-е и 80-е годы. Сейчас этот комплекс представляет собой систему межгосударственных стандартов (серия ГОСТ 19) стран СНГ, действующих на территории Российской Федерации, на основе межгосударственного соглашения по стандартизации.
Стандарты ЕСПД в основном охватывают ту часть документации, которая создается в процессе разработки ПС, и связаны, по большей части, с документированием функциональных характеристик ПС.
В соответствии с Законом РФ «О стандартизации» стандарты ЕСПД становятся обязательными на контрактной основе, то есть при ссылке на них в договоре на разработку (поставку) ПС. Это относится и ко всем другим стандартам в области программного обеспечения (ПО): комплексу стандартов ГОСТ 34, Международному стандарту ISO/IEC 12207 и др. Следует отметить, что стандарты ЕСПД носят рекомендательный характер и являются достаточно «гибкими» как в смысле структуры отдельных документов, так и на уровне всего пакета документов на программное изделие, т. е. стандарт ЕСПД допускает следующее: в документ можно включать любые дополнительные необходимые разделы, сливать короткие разделы и выносить отдельные разделы в приложения либо в отдельные документы. Допускается изменять окончательный состав пакета: могут быть убраны лишние и включены дополнительные документы.
Обозначение стандарта ЕСПД состоит из:
числа 19 (присвоено классу стандартов ЕСПД);
одной цифры (после точки), обозначающей код классификационной группы стандартов, указанной в табл. 2.1;
двузначного числа (после тире), указывающего год регистрации стандарта.
Таблица 2.1
Наименования и коды классификационных групп стандартов ЕСПД
Kод группы |
Наименование группы |
0 |
Общие положения |
1 |
Основополагающие стандарты |
2 |
Правила выполнения документации разработки |
3 |
Правила выполнения документации изготовления |
4 |
Правила выполнения документации сопровождения |
5 |
Правила выполнения эксплуатационной документации |
6 |
Правила обращения программной документации |
7 8 |
Резервные группы |
9 |
Прочие стандарты |
Перечень документов ЕСПД
|
ГОСТ 19.001-77 ЕСПД. |
Общие положения. |
|
ГОСТ 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.404-79 ЕСПД. |
Пояснительная записка. Требования к содержанию и оформлению. |
|
ГОСТ 19.501-78 ЕСПД. |
Формуляр. Требования к содержанию и оформлению. |
|
ГОСТ 19.502-78 ЕСПД. |
Описание применения. Требования к содержанию и оформлению. |
|
ГОСТ 19.503-79 ЕСПД. |
Руководство системного программиста. Требования к содержанию и оформлению. |
|
ГОСТ 19.504-79 ЕСПД. |
Руководство программиста. |
|
ГОСТ 19.505-79 ЕСПД. |
Руководство оператора. |
|
ГОСТ 19.506-79 ЕСПД. |
Описание языка. |
|
ГОСТ 19.508-79 ЕСПД. |
Руководство по техническому обслуживанию. Требования к содержанию и оформлению. |
|
ГОСТ 19.604-78 ЕСПД. |
Правила внесения изменений в программные документы, выполняемые печатным способом. |
|
ГОСТ 19.701-90 ЕСПД. |
Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения. |
|
ГОСТ 19.781-90 ЕСПД. |
Обеспечение систем обработки информации программное. |
Стиль применения стандартов может соответствовать современному общему стилю адаптации стандартов к специфике проекта: заказчик и руководитель проекта выбирают уместное в проекте подмножество стандартов и программных документов (ПД), дополняют выбранные ПД нужными разделами и исключают ненужные, привязывают создание этих документов к той схеме жизненного цикла (ЖЦ), которая используется в проекте.
При оформлении выпускных квалификационных работ бакалавров, дипломных проектов специалистов и магистерских диссертаций, предусматривающих разработку программ и программных систем, студентам рекомендуется применять следующие стандарты ЕСПД, которые чаще всего используются на практике:
ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению |
Стандарт, который можно использовать при формировании заданий на программирование. |
ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению. |
Стандарт, который должен использоваться при включении текстов программы в отчёт по лабораторной работе, пояснительную записку к курсовому или дипломному проекту. |
ГОСТ 19.402-78 ЕСПД. Описание программы |
Наиболее полный стандарт, ориентированный на документирование результирующего продукта разработки. |
ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Обозначения условные графические и правила выполнения.
|
Стандарт, который устанавливает правила выполнения схем, используемых для отображения различных видов задач обработки данных и средств их решения; полностью соответствует стандарту ISO 5807:1985. |