Лендинг курса
Docs-as-code · API Documentation

Технический
писатель в IT

Практический курс по docs-as-code и документированию API. Работайте с Git, Docusaurus и OpenAPI как настоящий технический писатель в IT-команде

30+
уроков
17
заданий и тестов
4
тренажёра
44
часа
tracking-history.mdx
---
title: История отслеживания
---
import ApiPlayground from '@theme/ApiPlayground'
# История отслеживания
<ApiPlayground
method="GET"
endpoint="/orders/{id}/tracking"
authRequired={true}
/>
git commit -m "docs: add tracking"
npm start
200 OK
Почему этот курс

Реальная практика, а не записанные лекции

17
практических заданий на реальном проекте
Вместо записанных лекций про документацию — вы создаёте доки в настоящей рабочей среде. Учебный репозиторий на GitHub, VS Code, терминал — всё как в реальной IT-команде.
Пишете пользовательскую документацию в MDX
Документируете API по реальной OpenAPI-спецификации
Делаете коммиты и pull request в репозиторий
Работаете с тем же стеком, что используют IT-компании
Проверка куратором с обратной связью
Каждое задание проверяет куратор — живой человек, не автопроверка. Вы получаете комментарии по коду и тексту, вносите правки и только после этого идёте дальше. Так учатся в настоящей команде.
Учебный репозиторий как портфолио
После курса у вас на GitHub лежит реальный проект — документация для курьерского сервиса с пользовательскими страницами и API-справочником. Это можно показать работодателю.
Интерактивный API прямо в документации
В учебном репозитории встроен API Playground — отправляете реальные запросы и видите ответы прямо на странице документации. Понимаете как работает API до того, как начинаете его описывать.
4 интерактивных тренажёра
Симулятор Git, тренажёр по MDX-разметке и другие — практикуетесь прямо в браузере без установки инструментов. Материал закрепляется намного лучше, чем при чтении теории.
Аудитория

Кому подойдёт курс

Техническим писателям
Уже работаете техническим писателем, но хотите освоить docs-as-code — или только присматриваетесь к профессии
Редакторам и копирайтерам
Уже работаете с текстом, но хотите перейти в технологическую компанию и зарабатывать больше
Разработчикам и тестировщикам
Пишете документацию внутри команды и хотите делать это системно и профессионально
Менеджерам продуктов
Документируете фичи и API, но делаете это интуитивно — хотите освоить стандарты индустрии
Предварительная подготовка

Необходимые знания

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

Будет проще, если вы хотя бы раз слышали слова «репозиторий» или «API» — но даже это не обязательно.

Формат

Как проходит обучение

20
часов теории
24
часа практики
44
часа всего
01
Читаете теорию и проходите тесты
УрокиТесты
Docs-as-code, Git, API — в своём темпе
02
Настраиваете рабочее окружение
Практика
Git, VS Code, npm — запускаете сайт локально
03
Выполняете задания на реальном проекте
17 заданийПроверка
Документация и API — с обратной связью куратора
04
Вносите правки и получаете сертификат
ЗамечанияСертификат
Дорабатываете по комментариям куратора
Отзывы

Что говорят студенты

★★★★★

Курс не из лёгких — это нужно честно признать. Но именно это и ценно. Наконец-то нормально объяснили, что такое docs-as-code и как это работает на практике, а не в теории. Работаешь прямо в репозитории, делаешь коммиты, оформляешь pull request — всё как в настоящей команде. Больше всего понравилась обратная связь куратора: подробно, по делу, без отписок. Понятно, что конкретно не так и как переделать.

Наталья В.
Редактор
★★★★★

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

Светлана М.
Менеджер продукта
★★★★★

Искал курс именно по docs-as-code — нашёл. Большинство других курсов по техническому письму учат писать тексты и всё. Здесь упор на инструменты: Git, Docusaurus, OpenAPI. Много практики — это главное. Задания реально сложные, особенно по API, но именно поэтому они запоминаются. Обратная связь куратора помогла увидеть вещи, которые сам бы не заметил.

Алексей Т.
Технический писатель
★★★★☆

Честно — ожидала чего-то попроще, но в итоге рада, что курс оказался серьёзным. Пришла как копирайтер, хотела понять как работают техписы в IT. Теперь понимаю и умею. Git уже не пугает, MDX-файлы пишу без проблем, с API разобралась. Практических заданий много, и это правильно — только через них и запоминается. Куратор не просто ставил галочки, а реально разбирал каждую работу.

Ирина К.
Копирайтер
Стек курса

Технологии и инструменты

Git GitHub VS Code Терминал Markdown MDX Docusaurus npm OpenAPI YAML REST API
Контроль версий
Git и GitHub — коммиты, ветки и pull request как в настоящей команде разработки
Публикация документации
Docusaurus — настраиваете сайт документации и видите результат в браузере
Документирование API
OpenAPI — описываете REST API по стандарту индустрии

Что вы будете уметь после курса

01
Писать пользовательскую документацию в формате docs-as-code
MDX-файлы, структура страниц, сайдбар, сниппеты — всё как в настоящей продуктовой команде
02
Документировать REST API по стандарту OpenAPI
Читать спецификацию, описывать эндпоинты, параметры, коды ошибок и схемы данных
03
Работать с Git и GitHub без помощи разработчиков
Создавать ветки, делать коммиты и pull request — самостоятельно от задачи до слияния
04
Запускать сайт документации локально
Настраивать Docusaurus и видеть результат в браузере до публикации
05
Структурировать документацию под разные аудитории
Понимать когда делить страницы, как строить навигацию, что писать для пользователей, а что для разработчиков
На выходе
Получить учебный репозиторий и сертификат
Реальный проект в GitHub и подтверждение навыков — можно показать работодателю уже после курса
Сертификат о прохождении

Получите демодоступ

Пройдите несколько уроков бесплатно после регистрации

Made on
Tilda