Документация для разработчиков
О чем курс
О документации, которую пишут и читают разработчики: о справочниках 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.
Преподает в Новосибирском государственном университете.