Documentat.io

Интенсивный курс для практикующих технических писателей и аналитиков, которым нужно начать работать с документацией по ГОСТ в области IT.

Научим ориентироваться в ГОСТах и применять их на практике. Расскажем, как писать и оформлять техническую документацию по стандартам, чтобы она прошла приемку. Разберем реальный пример комплекта документации по ГОСТ.

• Для опытных технических писателей, которые хотят разобраться в ГОСТах.

• Для инженеров, разрабатывавших конструкторскую документацию и решивших перейти в IT.

• Для любых сотрудников IT-компаний, которым по роду деятельности нужно создавать комплекты документации по ГОСТ.

Мы ожидаем, что слушатели этого курса знакомы с процессами разработки ПО и технической документации и/или имеют опыт работы в IT-компаниях.

• Стандарты, их назначение и применение. Обзор основных серий стандартов: ГОСТ 19 (ЕСПД) и 34 (КСАС), а также 2 (ЕСКД) и 7 (СИБИД). Ключевые различия между ГОСТ 19 и ГОСТ 34. Серия документационных стандартов ISO (обзорно).

• Особенности ГОСТовых проектов. Зачем писать документацию по ГОСТ? Ее бизнес-цели. Кто ее будет читать? Целевая аудитория. Паттерны чтения.

• Особенности документации по ГОСТ. Структура, содержание, оформление и стиль изложения. Предмет документирования. Документирование на разных стадиях разработки. Техническое задание.

• Комплект документов. Техническое задание, Пояснительная записка, Описание ПО, Описание применения, Руководства, Программа и методика испытаний — разбор каждого документа. Присвоение децимальных номеров.

• Взаимодействие с участниками разработки. Взаимодействие с техническими специалистами внутри команды, представителями заказчика, экспертами. Зоны ответственности. Подходы к «извлечению» исходных данных.

• Инструменты документирования. Совместная работа над документами. Шаблоны документов в MS Word и их настройка.

• Сроки и качество. Критерии качества документации. Глубина детализации. Баланс между документацией в срок и ее качеством: практические советы по оптимизации процесса документирования без ущерба для качества и репутационных рисков.

• Подготовка комплекта документов к приемке. Инструменты для самопроверки: чек-лист, матрица прослеживаемости требований и др. Ревью: внутреннее и внешнее, смысловое ревью для обеспечения полноты и точности документации.

• Согласование и приемка. Виды испытаний. Программа и методика испытаний. Доработка комплекта документов по замечаниям экспертов. Организационно-распорядительная документация.

• Реестр Минцифры (Реестр российского программного обеспечения). Подготовка технических документов для подачи заявления о включении сведений о ПО в реестр. Требования реестра к техническим документам. Комплект документов. Варианты подачи.

Формат курса