Documentat.io

Документация для разработчиков

О чем курс

О документации, которую пишут и читают разработчики: о справочниках API, о документации микросервисов, об описании программных архитектур, о README и всём прочем, что сопровождает создание программмных систем.

Для кого

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

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

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

  • Техническая документация как форма проектной коммуникации. Когда документация лучше других способов коммуникации. Зачем и кому нужна документация. Качество документации и ее ROI.

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

  • Жанры документации для разработчиков: Howto, tutorial, reference, explanation. Отвратительные примеры жанросмешения в документации.

  • Документирование API: целеполагание, формат, структура, критерии качества. Разделение reference/howto/tutorial. Генераторы OpenAPI, инструментарий генерации смешанной OpenAPI/MD документации.

  • Документирование архитектуры: целеполагание, целевые аудитории, критерии качества. Подходы из стандартов ISO/IEC/IEEE, концепции C4 и arc42.

  • Обзор современного инструментария docs-as-code. Статические генераторы Markdown/RST → HTML. Pandoc. Foliant.

Следующий курс

Осень 2022

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

Онлайн

Стоимость
25 000 руб. Записаться
Возможно проведение курса для корпоративных групп
Продолжительность

Четыре дня
(10:00–14:00 Мск)

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

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

Технический директор documentat.io, компании по заказной разработке документации.

В прошлом — руководитель отдела документирования в Zodiac Interactive.

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

Оставьте заявку на участие в курсе!

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

После отправки заявки наш менеджер свяжется с вами и пришлет ссылку на оплату картой. Заявка бронирует за вами место, но ни к чему вас не обязывает: вы можете передумать в любой момент до оплаты.

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


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

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

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

После отправки заявки наш менеджер свяжется с вами и пришлет ссылку на оплату картой. Заявка бронирует за вами место, но ни к чему вас не обязывает: вы можете передумать в любой момент до оплаты.

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


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

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

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

© 2016–2022 Семён Факторович и команда