Documentat.io

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

Что это за курс

Открытый и бесплатный семестровый курс по технической документации в IT. Занятия проходят каждую неделю с марта по май.

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

Для кого

  • Для тех, кто хочет познакомиться с профессией технического писателя и начать строить карьеру в этой области.

  • Для тех, кто уже работает техническим писателем, но хочет расширить и систематизировать свои знания.

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

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

  • Понятие технической документации. Роль документации в жизненном цикле IT-продуктов и IT-проектов. Какие задачи решаются технической документацией, а какие — нет. Что не является технической документацией. Примеры технических документов.

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

  • Документационное обеспечение проектов по созданию ПО. Индустриальные стандарты и рекомендации. Серии стандартов ЕСКД (ГОСТ 2.x), ЕСПД (ГОСТ 19.x), КСАС (ГОСТ 34.x). Англоязычные серии документационных стандартов ISO/IEC/IEEE.

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

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

  • Процессы вычитки и рецензирования технических документов. Критерии качества для технической документации.

  • Поддержка актуальности документации. Неизбежное «отставание» документации от реального положения дел. Поддержка консистентности набора документов. Сбор обратной связи от потребителей документации.

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

  • Методология "docs as code". Хранение документации в системах контроля версий (Git, SVN) наравне с кодом. Легковесные языки текстовой разметки (Markdown, rST). Автоматизированные системы верификации, сборки и публикации контента. Непрерывная интеграция и непрерывное развертывание (continuous integration/continuous delivery) для документации.

  • Документирование API. Swagger и OpenAPI Specification, Postman.

  • Техническая коммуникация как надмножество технической документации. Техническая коммуникация в рамках проекта, продукта, команды, компании. Требования к объектам технической коммуникации. Процессы обеспечения успешной технической коммуникации, их сравнение с процессами документирования. Понятие управления знаниями (knowledge management).

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


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

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

Расписание

(уточняется)

Первое занятие

Февраль 2019

Место проведения

Новосибирск, ул. Пирогова, д.1 (новый норпус НГУ), аудитория 2128

Стоимость
Бесплатно Записаться

Ведущий курса

Семён
Факторович

Руководитель отдела техдокументации компании HDsoft (новосибирского подразделения американской компании Zodiac Interactive)

Более 7 лет занимается технической документацией в разных ее проявлениях.

Преподает в Новосибирском государственном университете.

Оставьте заявку

Мы свяжемся с вами в ближайшее время.

или пишите на info@documentat.io


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

Спасибо, ваш запрос отправлен!
Мы свяжемся с вами в самое ближайшее время.

Что-то пошло не так, и форма не отправилась.
Напишите, пожалуйста, свой вопрос или заявку на info@documentat.io