Documentat.io

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

Расскажем обо всем понемногу: о типах технических документов, об управлении документационными процессами и о документационном инструментарии.

Двухнедельный вводный курс для желающих войти в профессию.

Для тех, кто никогда не работал техническим писателем или даже не знаком с IT-индустрией.

Семинар для практикующих техписателей.

Расскажем тонкости и хитрости, интересные для специалистов с опытом.

Давно и успешно пишете, но хотите писать еще лучше? Вам сюда.

Расскажем о принципах REST API, о современном инструментарии документирования API и о взаимодействии техписателя и команды разработки.

DITA — технология, которая формально относится к парадигме Docs as Code, но сильно отличается от других общеизвестных инструментов.

Этот курс рассказывает о специфике DITA, о ее сильных сторонах и о ее границах применимости.

Практическая часть курса позволит «потрогать» DITA руками и самостоятельно собрать документы с помощью стандартных инструментальных цепочек этой технологии.

Ревью — не жаргонизм, а устоявшийся термин. В рамках ревью мы вычитываем технические документы, делаем текст более понятным и улучшаем его стилистику, следим за соблюдением стайлгайдов, а также проверяем, что документ не содержит неправды.

Этот курс рассказывает о приемах, процессах и этикете ревью технической документации.

В практической части курса мы проведем ревью фрагмента вашей документации по стандартам documentat.io.

Неожиданно обнаружили, что вместо написания документации занимаетесь руководством другими техписателями?

Расскажем о том, как управлять документационными специалистами, как растить и обучать их, и как при этом не сойти с ума.

Вы опытный техписатель, но еще не сталкивались с ГОСТами?

Расскажем, чем работа по ГОСТ и другим российским стандартам отличается от других техписательских задач. Научим писать и сдавать ГОСТ-комплекты документации.

Есть задача описывать архитектуру со слов разработчиков, но непонятно, как к ней подступиться?

Уверенно чувствуете себя во всех остальных аспектах техписательской профессии, но не знаете, с чего начать погружение в мир архитектуры?

Дадим всю необходимую теорию и поможем с практикой!

Понимаете важность иллюстративного материала в документации, но не обладаете системными навыками в его подаче?

Расскажем всю нужную теорию и потренируемся в донесении визуальных образов!

Расскажем о том, как техписателю, аналитику или инженеру использовать скриптовую и ИИ-автоматизацию при подготовке технических документов.

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

Не знаете, с чего начать и за что взяться?

Не волнуйтесь, мы всё вам расскажем и всему научим!