Documentat.io

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

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

Открытый и бесплатный семестровый курс о технической документации в 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 и другие.


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

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

Расписание

Уточняется

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

Февраль 2018

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

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

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

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

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

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

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

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

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

Мы свяжемся с вами в ближайшее время.
Если вы оставите свой номер телефона, то мы сможем пообщаться еще быстрее.

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

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

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