Почему этот курс
Работаете руками, а не просто слушаете теорию
17
практических заданий на реальном проекте
Вместо записанных лекций вы работаете с документацией в настоящем рабочем проекте. Учебный репозиторий на GitHub, VS Code, терминал — всё как в реальной IT-команде
Пишете пользовательскую документацию в MDX
Документируете API по реальной OpenAPI-спецификации
Делаете коммиты и отправляете пулл-реквесты в репозиторий
Работаете с тем же стеком, который используют IT-компании
Обратная связь от куратора
Каждое задание разбирает куратор — практикующий технический писатель. Никакой автопроверки — только живая обратная связь по коду и тексту. Вносите правки и только после этого идёте дальше. Так учатся в настоящей команде
Учебный репозиторий как портфолио
После курса у вас на GitHub будет реальный проект с документацией. Это конкретный плюс к резюме: работодатель видит код, структуру, описание API — всё, что вы сделали своими руками
Интерактивный API прямо в документации
В учебном репозитории есть встроенный инструмент для тестирования 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
Вносите правки и получаете сертификат
ПравкиСертификат
Дорабатываете по комментариям куратора
Стек курса
Технологии и инструменты
Git GitHub VS Code Markdown MDX Docusaurus npm OpenAPI YAML REST API
Контроль версий
Git и GitHub — коммиты, ветки и пулл-реквесты как в настоящей команде разработки
Публикация документации
Docusaurus на практике: вы настраиваете сайт документации и сразу видите результат в браузере
Документирование API
Научитесь описывать REST API: методы, параметры, ответы, ошибки
Что вы будете уметь после курса
01
Создавать пользовательскую документацию в парадигме Docs as Code
MDX-файлы, сайдбар, сниппеты — всё как в настоящей продуктовой команде
02
Документировать REST API по стандарту OpenAPI
Читать спецификацию, описывать эндпоинты, параметры, коды ошибок и схемы данных
03
Работать с Git и GitHub без помощи разработчиков
Создавать ветки, делать коммиты и пулл-реквесты самостоятельно
04
Запускать сайт документации локально
Настраивать Docusaurus и видеть результат в браузере до публикации
05
Структурировать документацию под разные аудитории
Понимать когда делить страницы, как строить навигацию, что писать для пользователей, а что для разработчиков
На выходе вы получите готовое портфолио и сертификат
Реальный проект в GitHub и подтверждение навыков — можно показать работодателю уже после курса
Сертификат о прохождении
Содержание
Программа курса
01Документация как код: введение и цели
⌄
02Рабочее окружение технического писателя
⌄
03Публикация документации с Docusaurus
⌄
04Обзор учебного репозитория
⌄
05Работа с пользовательской документацией
⌄
06Работа с API
⌄
Интерактивный API в учебном репозитории Что такое API и типы веб-API REST API и инструменты для работы с API Тест 3. Вопросы по разделу «Работа с API» Задание 9. Первое знакомство с API Как устроен файл OpenAPI Задание 10. Исправление синтаксиса Задание 11. Документирование нового метода Задание 12. Дополнение кодов ошибок Задание 13. Обновление главной страницы API Задание 14. Документирование метода «Список заказов»
| Сертификат После прохождения курса выдается электронный сертификат, если студент:
|
Записаться на курс
Учиться можно сразу
25 000 ₽
Обратная связь куратора по каждому заданию
Доступ к учебному репозиторию «Экспресс сервис»
Портфолио на GitHub и сертификат
Попробуйте бесплатно
Зарегистрируйтесь и пройдите несколько уроков уже сегодня
