Открытый курс «Техническая документация в IT-проектах»

27 февраля на базе ФИТ НГУ стартует открытый курс «Техническая документация в IT-проектах».

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

Программа курса:

• Понятие технической документации. Зачем она нужна, какие задачи решает. Отличия технического документа от других видов текстов. Профессия технического писателя.

• Техническая документация и технические писатели в IT. Какие задачи решает документация в IT-индустрии. Чем занимается технический писатель в IT-компании. Профессиональный и карьерный рост технического писателя.

• Типичные жанры технических документов в IT: технические задания, требования, архитектурные документы, пользовательская документация, документация по развертыванию программных систем.

• Общие для всех жанров документации особенности. Структура технического текста. Техническая стилистика.

• Место технической документации в проектах по разработке ПО. Отношение различных методологий разработки к документации в целом. Наборы документов, регламентированные разными методологиями.

• Пользовательские инструкции, их типичный формат. Понятие о комплексах пользовательской документации (user manuals).

• Технические задания и требования к программному обеспечению. Функциональные и технические спецификации, Software Requirements Specifications (SRS). Use-cases как один из форматов описания требований.

• Как хранить документацию. Требования к системам хранения документации: версионирование, diffability, совместное редактирование, адресный доступ до каждого документа, иерархическая структура. Варианты систем хранения: wiki-движки, специализированные документационные хранилища (Google Drive), системы контроля версий (Git/SVN).

• В чем создавать документацию. Требования к текстовым редакторам, plaintext и non-plaintext форматы. Разделение исходников и представления: генерация docx, PDF и HTML из plaintext-разметки (Markdown, rST, XML). Понятие single sourcing. Обзор технологии DITA.

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

• Документационные стандарты. Регламентированные шаблоны документов, рекомендации по процессам документирования. Обзор существующих решений: группы стандартов IEEE, ISO, ГОСТ 19, ГОСТ 34 и другие.

Первое занятие состоится 27 февраля в 19:00 в аудитории 2128 нового корпуса НГУ.

Посещать курс могут все желающие, необходима предварительная регистрация.

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

Все вопросы можно задать Семёну Факторовичу, sam.faktorovich@gmail.com