Программа мероприятия

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

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

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

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

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

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

Для выступления приглашены: технические писатели, руководители и специалисты ведущих российских предприятий

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

2.   Требования национальных и межгосударственных стандартов к оформлению документации — актуальные и сложные вопросы.  Единые стандарты документирования: цели и задачи стандартизации. Классификация и назначение ГОСТов, ЕСКД, ЕСТД, ЕСПД, ИСО. Серии стандартов для разработки текстовых документов: ЕСКД (ГОСТ 2.), ЕСТД (ГОСТ 3.), СИБИД (ГОСТ 7.), СРПП (ГОСТ 15.), ЕСПД (ГОСТ 19.) ГОСТ 34. Управление документированной информацией в контексте требований МС ISO 9001:2015.

3.   Приемы работы с техническими текстами.  Типовые формулировки, тон и стиль изложения, терминология, клише, штампы, формат представления. Терминология в технической документации: правила применения единых терминов. Частые ошибки и лексические тонкости в технических документах.

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

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

6.    Правила и особенности разработки различных видов документов: формат, структура, содержание — на что обратить внимание? Сложные и спорные моменты.

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

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

8.  Какое программное обеспечение использовать в работе в условиях санкций?

• Базовые форматы текстовой документации DOC(X), ODT, RTF, PDF, HTML, CHM;
• Средства MS Office и LibreOffice; Средства Adobe; Разработка схем деления в Visio
• Инструменты для разработки электронных справок (Microsoft HTML Help Workshop, Help&Manual, RoboHELP);
• Технологии и средства для автоматизации документирования
• Системы единого источника, контроля версий, формирования справок и библиотек

9.     Создание векторных изображений в документах. Векторные изображения в документе. Иллюстрации и вставка изображений в MS Word. Фотография и векторная иллюстрация. Методика отрисовки графики в PowerPoint.

10. Техническая документация на иностранном языке: как построить свою работу? Правила и способы перевода технических текстов. Применяемое программное обеспечение. Онлайн-словари, переводчики, программы Translation memory. Сложности перевода на другой язык, основные подводные камни. Локализация в технических переводах.

11.  Практические аспекты по организации работы. Как организовать контроль за ошибками в объемном документе? Редактирование, проверка на соответствие заданным стандартам качества, работа с замечаниями внутреннего или внешнего заказчика, устранение выявленных недочетов, улучшение и обновление документации по мере развития продукта. Процесс согласования и визирования новых документов.