надо. ГОСТы и ЕСПД 2018-2019. СтандартыЕдиная Система ПрограммнойДокументации (еспд)
 Скачать 0.56 Mb.
|
|
Стандарты Единая Система Программной Документации (ЕСПД) Факультет компьютерных наук Центр практик и проектной работы 2018-2019 фото фото фото Справочно: Проект — совокупность мероприятий для разработки нового продукта или улучшения существующего продукта ISO/IEC 26514 Systems and software engineering — Requirements for designers and developers of user documentation. Проект — предприятие (предпринятие) с определёнными датами начала и завершения, предпринятое для создания продукта или услуги (сервиса) в соответствии с заданными ресурсами и требованиями ISO/IEC/IEEE 15288:2008 Systems and software engineering — System life cycle processes; ISO/IEC 15939:2007 Systems and software engineering — Measurement process Определения проекта фото фото фото Для того, чтобы превратить программный код в продукт (программное обеспечение), нужно снабдить его всей необходимой документацией. В рамках курсовой работы на ОП ПИ и проектной работы на ОП ПМИ создается продукт (программное обеспечение). Программирование, Алгоритмы и структуры данных, ООП и т.д. – учат писать код. ??? – учат писать документацию. Документация составляется по стандартам. Стандарты для написания документации делятся на два типа: • Международные стандарты (ISO, IEEE Std); • Советские и Российские ГОСТы. (В обозначении Российских стандартов – символ Р) Программа → Продукт Продукт = программный код + документация фото фото фото Документация – важная составляющая продукта фото фото фото Список основных международных стандартов для написания документации: • IEEE Std 1063-2001 «IEEE Standard for Software User Documentation» — стандарт для написания руководства пользователя; • IEEE Std 1016-1998 «IEEE Recommended Practice for Software Design Descriptions» — стандарт для написания технического описания программы; • ISO/IEC FDIS 18019:2004 «Guidelines for the design and preparation of user documentation for application software» — ещё один стандарт для написания руководства пользователя. Содержит большое количество примеров, похоже на руководство по написанию руководства пользователя. • ISO/IEC 26514:2008 «Requirements for designers and developers of user documentation» — стандарт для дизайнеров и разработчиков пользователей документации. Международные стандарты фото фото фото ГОСТы — это нечто, что разрабатывалось при Союзе, их слишком много. ГОСТов для IT не так много, и они все не потеряли актуальности. Для написания документации на программу используются две серии ГОСТов – ГОСТ 19 Единая система программной документации (ЕСПД) – ГОСТ 34 Информационные технологии. Комплекс стандартов на автоматизированные системы. ____________________________________________________________________________________ Справочно: ГОСТ (государственный стандарт ) – это нормативно-правовой документ, в соответствии требованиями которого производится стандартизация производственных процессов и оказания услуг. Государственный стандарт обязательно проходит процедуру регистрации, которая проводится специальным государственным органом - Госстандартом. ГОСТы могут заменяться или отменяться. Действующие ГОСТы обязательны к исполнению. Утвержденный ГОСТ содержит ключевые требования, которым должны соответствовать товары, работы и услуги, в отношении которых он принимается, для обеспечения их эффективной и безопасной эксплуатации. ГОСТы фото фото фото ЕСПД (единая система программной документации) - комплекс государственных стандартов (ГОСТ), устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации. Стандарты ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ. Определения из ЕСПД: • Программа — данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определённого алгоритма. • Программное обеспечение — совокупность программ системы обработки информации и программных документов, необходимых для эксплуатации этих программ. ГОСТ 19. ЕСПД фото фото фото Определение из ГОСТ 34 • Автоматизированная система (АС) — система, состоящая из персонала и комплекса средств автоматизации его деятельности, реализующая информационную технологию выполнения установленных функций. В зависимости от вида деятельности выделяют, например, следующие виды АС: автоматизированные системы управления (АСУ), системы автоматизированного проектирования (САПР), автоматизированные системы научных исследований (АСНИ) и другие. ГОСТ 34 разделяет виды обеспечения АС: • Организационное; • Методическое; • Техническое; • Математическое; • Программное обеспечение; • Информационное; • Лингвистическое; • Правовое; • Эргономическое. Автоматизированная система — это не программа, а комплекс видов обеспечения, среди которых есть и программное обеспечение. ГОСТ 34. ИТ фото фото фото Автоматизированная система, как правило, содержит организационное решение под конкретного пользователя и заказчика Программа может быть создана и растиражирована под большое количество пользователей без привязки к какому-либо предприятию Если разрабатывается документация на программу, которую создают под конкретное предприятие, то используется ГОСТ 34. Если разрабатывается документация на массовую программу, то используется ГОСТ 19. Пункты технического задания ГОСТа 34 и ГОСТа 19 отличаются. Рассмотрим ТЗ по ГОСТ 19 ГОСТ 19 vs ГОСТ 34 фото фото фото Состав ГОСТ 34 ИТ (1) • ГОСТ 34.201-89 Виды, комплектность и обозначения документов при создании автоматизированных систем • ГОСТ 34.320-96 Концепции и терминология для концептуальной схемы и информационной базы • ГОСТ 34.321-96 Информационные технологии. Система стандартов по базам данных. Эталонная модель управления • ГОСТ 34.601-90 Автоматизированные системы. Стадии создания • ГОСТ 34.602-89 Техническое задание на создание автоматизированной системы • ГОСТ 34.603-92 Информационная технология. Виды испытаний автоматизированных систем • РД 50-34.698-90 Автоматизированные системы. Требования к содержанию документов фото фото фото Состав ГОСТ 34 ИТ (2) • ГОСТ Р ИСО/МЭК 8824-3-2002 Информационная технология. Абстрактная синтаксическая нотация версии один • ГОСТ Р ИСО/МЭК 10746-3-2001 Управление данными и открытая распределённая обработка. • ГОСТ Р ИСО/МЭК 15271-02 Процессы жизненного цикла программных средств • ГОСТ Р ИСО/МЭК 15910-2002 Процесс создания документации пользователя программного средства фото фото фото ГОСТ 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 ЕСПД (1) фото фото фото ГОСТ 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 ЕСПД (2) фото фото фото ГОСТ 19.507—79 Единая система программной документации. Ведомость эксплуатационных документов ГОСТ 19.508—79 Единая система программной документации. Руководство по техническому обслуживанию. Требования к содержанию и оформлению ГОСТ 19.601—78 Единая система программной документации. Общие правила дублирования, учета и хранения ГОСТ 19.602—78 Единая система программной документации. Правила дублирования, учета и хранения программных документов, выполненных печатным способом ГОСТ 19.603—78 Единая система программной документации. Общие правила внесения изменений ГОСТ 19.604—78 Единая система программной документации. Правила внесения изменений в программные документы, выполненные печатным способом ГОСТ 19.701—90 (ИСО 5807—85) Единая система программной документации. Схемы алгоритмов, программ, данных и систем. Обозначения условные и правила выполнения ГОСТ 19.781—90 Обеспечение систем обработки информации программное. Термины и определения Состав ГОСТ 19 ЕСПД (3) фото фото фото В результате выполнения курсового проекта (курсовой работы) должны быть обязательно разработаны документы по ГОСТ: • Техническое задание • Пояснительная записка • Руководство оператора • Программа и методика испытаний • Текст программы Опционально, при необходимости: • Описание языка • Руководство программиста • Руководство системного программиста • И т.д. Техническое задание и Пояснительная записка – распечатать, подписать, загрузить в ЛМС, сдать на носителе РО, ПМИ, ТП – титульные листы распечатать и подписать, документы загрузить в ЛМС и сдать на носителе Состав документации к курсовому проекту ПИ фото фото фото В результате выполнения программного проекта должны быть обязательно разработаны документы по ГОСТ: • Техническое задание • Пояснительная записка • Руководство оператора • Программа и методика испытаний • Текст программы Опционально, при необходимости: • Описание языка • Руководство программиста • Руководство системного программиста • И т.д. Техническое задание и Пояснительная записка – распечатать, подписать, загрузить в ЛМС, сдать на носителе Состав документации к программному проекту ПМИ фото фото фото Если проект выполняется группой студентов, то соответствующая документация оформляется каждым студентом отдельно на свою часть работы – подсистему программной системы, разрабатываемой группой. Кроме того, группа предоставляет дополнительно два документа: • общее техническое задание на всю программную систему, на основе которого формулируются частные технические задания на разработку подсистем; • программа и методика испытаний всей системы. Состав документации к командному проекту фото фото фото Должны быть обязательно разработаны документы по ГОСТ: 1. Техническое задание (на всю систему) 2. Программа и методика испытаний (на всю систему) 3. Техническое задание (на подсистему) 4. Пояснительная записка (на подсистему) 5. Руководство оператора (на подсистему) 6. Программа и методика испытаний (на подсистему) 7. Текст программы (на подсистему) Техническое задание, Программа и методика испытаний на всю систему – общие на команду Документы 3-7 – индивидуальные Документы 1-4 распечатать, подписать, загрузить в ЛМС, сдать на носителе Документы 5-7 (только ПИ) распечатать и подписать титульные листы, загрузить в ЛМС, сдать на носителе Состав документации к командному проекту фото фото фото ГОСТ 7.32-2017. Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления Дата введения: 07/01/2018 Вместо проекта ТЗ необходимо сдать Аннотацию работы + Список источников (контр. точка 1 для ПМИ, до 1 декабря для ПИ) К защите Отчет об исследовательском проекте – распечатать, подписать, загрузить в ЛМС, сдать на носителе ГОСТ для оформления исследовательской работы ))) фото фото фото Аннотация должна содержать: • перечень ключевых слов; (от 5 до 15 слов или словосочетаний, которые в наибольшей мере характеризуют его содержание работы и обеспечивают возможность информационного поиска) Текст аннотации должен отражать: • объект исследования или разработки; • цель работы: • методы или методологию проведения работы; • предполагаемые результаты работы и их новизну: • область применения результатов работы; • предполагаемое внедрение результатов работы; • экономическую эффективность или значимость работы; • прогнозные предположения о развитии объекта исследования. Если в аннотации нет сведений по какой-либо из перечисленных структурных частей, то в тексте аннотации она опускается, при этом последовательность изложения сохраняется. Аннотация исследовательской работы Россия, Москва, Кочновский пр., д. 3 Тел.: (495) 772-95-90 * 22-514 Тел.: (495) 772-95-90 * 22-518 Тел.: (495) 772-95-90 * 22-520 www.hse.ru |