Cтaндарты ЕCПД и современные требования к документации. Разработки технических текстов и документации
Программа предлагает глубокое и практико-ориентированное погружение в современную систему стандартов документирования программного обеспечения и автоматизированных систем. Особое внимание уделено ЕСПД, а также актуализированным требованиям ГОСТ 34, ГОСТ Р 59 и ГОСТ Р 51, которые сегодня определяют правила разработки, оформления и сопровождения документации в IT-проектах, интеграционных решениях и системах в защищённом исполнении. Помимо нормативной составляющей, участники отрабатывают ключевые навыки технического писателя: структурирование материалов, оптимизация технических текстов, взаимодействие с техническими специалистами и обеспечение качества документации. В результате слушатели формируют цельную и практичную карту стандартов, учатся корректно подготавливать документы для разработки, внедрения и сопровождения ПО и АС, а также уверенно ориентируются в современных требованиях к технической и проектной документации.
Цель курса повышения квалификации
- сформировать у участников уверенное понимание принципов создания понятных, точных и проверяемых технических текстов;
- дать практические методы и инструменты для повышения качества документации в организации;
- предоставить структурированную карту актуальных стандартов (ЕСПД, ГОСТ 34, ГОСТ Р 59, ГОСТ Р 51);
- научить определять, какие документы необходимы на разных этапах проекта;
- сформировать навыки корректной подготовки документации для разработки, внедрения и сопровождения программного обеспечения и автоматизированных систем.
В программе курса повышения квалификации
День 1
Практикум технического писателя: разработка, оптимизация, контроль и сопровождение производственной документации.
Техническая документация и технический писатель: основные термины и понятия.
- Профессиональный стандарт «Технический писатель»: содержание и требования. Стандарты разработки технической документации.
- Содержание работы технического писателя. Отличия техписа от обычного писателя и от писателя-аналитика.
- Виды занятости, связанные с разработкой документации и основные виды создаваемых документов.
- Задачи, навыки и умения технического писателя. Сферы деятельности техписа, варианты занятости.
- Принципы документирования. Производственные метрики. Критерии качества.
Виды, стили и принципы создания технических текстов.
- Техническая документация как канал коммуникации. Виды и жанры технической документации.
- Этапы создания текста, жизненный цикл документа.
- Разработка технической документации. Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации.
- Жанровый и сценарный подход. Функциональная и ролевая документация.
Средства, методы и приёмы создания технических текстов.
- ПО, принцип единого источника, стандарт DITA.
- Аудитория документа, карта участников и план коммуникации, разработка структуры и создание текста для читателя. Преодоление коммуникационных барьеров.
- Определение уровня разъяснения материала и допустимой сложности языка.
- Визуализация и графическое сопровождение технических документов.
Язык технического текста.
- Стиль технического текста. Удобочитаемость
- Лексика технического текста. Терминология, принцип терминологического единства. Введение новых терминов.
- Синтаксис технического текста. Актуальное членение.
- Оптимизация технического текста.
- Визуализация и графическое сопровождение технических текстов.
- Виды ошибок и контроль ошибок в техническом тексте.
- Базовые процессы контроля документации. Версионирование.
День 2
Стандарты ЕСПД и современные требования к программной документации. Автоматизированные системы. Документирование создания автоматизированных систем по ГОСТ серии 34; Р51 и Р59.
Определение и назначение стандартов ЕСПД. Область распространения стандартов ЕСПД. Основные положения стандартов ЕСПД.
- Классификация и обозначение стандартов ЕСПД. Перечень стандартов ЕСПД.
- Общие положения. Назначение ЕСПД. Область распространения и состав ЕСПД. ГОСТ 19.001.
- Структура обозначения программ и программных документов. Виды программ и программных документов ГОСТ 19.101.
- Стадии разработки программ и программной документации ГОСТ 19.102.
- Обозначение программ и программных документов. ГОСТ 19.103
- Основные надписи. ГОСТ 19.104.
- Общие требования к программным документам ГОСТ 19.105.
- Требования к программным документам, выполненным печатным способом. ГОСТ 19.106
- Техническое задание ГОСТ 19.201.
- Спецификация ГОСТ 19.202.
- Программа и методика испытаний ГОСТ 19.301.
- Текст программы ГОСТ 19.401.
- Пояснительная записка ГОСТ 19.404.
- Формуляр ГОСТ 19.501.
- Описание применения ГОСТ 19.502.
- Руководство программиста ГОСТ 19.504.
- Руководство оператора ГОСТ 19.505.
- Ведомость эксплуатационных документов ГОСТ 19.507.
- Руководство по техническому обслуживанию ГОСТ 19.508.
- Общие правила внесения изменений ГОСТ 19.603.
- Государственная регистрация ПО. Виды и примеры заявочных документов
- Последовательность действий при госрегистрации ПрЭВМ и БД
- Перечень документов и материалов, представляемых заявителем
- Требования к документам, представляемым заявителями
ГОСТ 34 Информационные технологии. Автоматизированные системы.
- Перечень стандартов ГОСТ 34, Р59 и Р51, рассматриваемых в курсе.
- Информационные технологии. Комплекс стандартов на автоматизированные системы. ГОСТ Р 59853 (вместо ГОСТ 34.003). Автоматизированные системы. Термины и определения.
- Информационные технологии. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначение документов при создании автоматизированных систем ГОСТ 34.201.
- Информационные технологии. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы ГОСТ 34.602.
ГОСТ Р 59 Комплекс стандартов на автоматизированные системы.
- Комплекс стандартов на автоматизированные системы. Стадии создания ГОСТ Р 59793 (вместо ГОСТ 34.601).
- Комплекс стандартов на автоматизированные системы. Требования к содержанию документов ГОСТ Р 59795 (вместо РД 50-34.698).
- Комплекс стандартов на автоматизированные системы. Виды испытаний автоматизированных систем. ГОСТ Р 59792 (вместо ГОСТ 34.603).
- Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов ГОСТ Р 59795.
ГОСТ Р 51 Защита информации.
Защита информации. Порядок создания автоматизированных систем в защищенном исполнении. Общие положения ГОСТ Р 51583.
Для кого предназначен курс повышения квалификации
Технических писателей и начинающих специалистов, осваивающих документирование; сотрудников, ответственных за разработку, оформление и сопровождение технической документации; аналитиков, инженеров, архитекторов, тестировщиков (QA) и других технических специалистов; менеджеров проектов и руководителей команд разработки; специалистов по документации в сфере промышленности, IT и государственного сектора; всех, кто взаимодействует с исполнителями или заказчиками по вопросам документирования.
Раздаточные материалы
Методический материал.
Документ по окончанию курса повышения квалификации
Преподаватели курса повышения квалификации
Преподаватель
Технический писатель IBS на проекте с Huawei, переводчик, редактор, копирайтер, специалист по исследованиям, эксперт по инновациям, руководитель проектов, консультант по стратегическому развитию.
Преподаватель/инструктор с опытом работы в разных отраслях (промышленность, строительство, девелопмент и маркетинг недвижимости).
Автор креативных концептов, создатель художественных брифов и технических заданий для проектов в России, Германии, Казахстане, Мексике, соавтор монографии по клиентоцентричности в ритейле и индустрии развлечений.
Преподаватель
Эксперт по подготовке и проверке отчетной научно-технической документации, создаваемой в рамках НИОКР по созданию средств вооружения, военной и специальной техники, а также высокотехнологичного оборудования машиностроительного производства.
Преподаватель
Кандидат технических наук по специальности 05.02.05 «Роботы, манипуляторы и робототехнические комплексы» (2005 г.). Лауреат Премии Правительства РФ в области науки и техники (2008 г.).
Автор четырех учебных пособий, 14-ти изобретений, защищенных патентами РФ, и более 20-ти публикаций по тематике специальной и классической робототехники и мехатроники (в т.ч. в журналах перечня ВАК, и системе международного цитирования «Scopus»). Участник свыше 30-ти научно-практических и специализированных конференций, симпозиумов и совещаний.
Профессиональный опыт работы на предприятиях тяжёлого машиностроения. Заместитель генерального директора - Главный инженер. Главный конструктор.
Отзывы
Похожие курсы
Подождите, идет загрузка информации...