Documentat.io

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

Курс дает полное представление о применении стандартов при документировании ИТ-решений, в том числе созданных на основе актуальных технологий. Мы разберем, какие стандарты используются в проектах, когда они обязательны, как их выбирать и сочетать. Подробно рассмотрим документирование автоматизированных систем по КСАС (ГОСТ 34) и программных средств по ЕСПД (ГОСТ 19), а также организацию разработки и автоматизацию документации.

Курс адресован техническим писателям, аналитикам, архитекторам и руководителям проектов, которые работают с технической документацией в ИТ-проектах.

Предполагается, что участники знакомы с процессами разработки программного обеспечения и имеют практический опыт работы в ИТ-проектах.

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

• Основные виды ИТ-продукции в свете документирования. Классификация ИТ-продукции с точки зрения стандартов. Автоматизированные системы, аппаратно-программные комплексы, средства. Нормативные определения указанных видов продукции и различия между ними. Связь вида продукции с составом и структурой комплекта технической документации.

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

• Документирование программных средств в соответствии с ЕСПД. Область применения ЕСПД и ее соотношение с КСАС. Состав документации на программное средство: техническое задание на программу, пояснительная записка, описание программы, описание применения, руководства. Требования к структуре и оформлению. Присвоение обозначений и децимальных номеров. Типичные ошибки при разработке документации на программные средства.

• Составление отчетной документации. Отчеты об обследовании объекта автоматизации. Отчеты о НИР и НИОКР, концепции и технические предложения. Назначение этих документов, их структура и роль в формировании последующего комплекта документации.

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

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

• Автоматизация разработки документации по ГОСТ. Методология единого источника. Многократное использование фрагментов документации. Docs as Code. Хранение документации в системах контроля версий. Использование легких текстовых разметок. Автоматическое формирование выходных форматов. Управление версиями и изменениями.

Формат курса

Раздаточные материалы

Остались вопросы?