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

Технический писатель
в Docs as Code

Научим работать с Git, Docusaurus и OpenAPI на реальных задачах

44
часа теории и практики
17
заданий и тестов
4
тренажёра
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
Вносите правки и получаете сертификат
ПравкиСертификат
Дорабатываете по комментариям куратора
Стек курса

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

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 без помощи разработчиков
Создавать ветки, делать коммиты и пулл-реквесты самостоятельно
04
Запускать сайт документации локально
Настраивать Docusaurus и видеть результат в браузере до публикации
05
Структурировать документацию под разные аудитории
Понимать когда делить страницы, как строить навигацию, что писать для пользователей, а что для разработчиков
На выходе
Получить готовое портфолио и сертификат
Реальный проект в GitHub и подтверждение навыков — можно показать работодателю уже после курса
Сертификат о прохождении
Содержание

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

Урок
Задание
Тест
01Документация как код: введение и цели
⌄
Цели курса
Экскурс в документирование
Обзор Docs as Code
Тест 1. Вопросы по процессам Docs as Code
02Рабочее окружение технического писателя
⌄
Что такое командная строка
Командная строка: продвинутый уровень
Пути в файловой системе
Руководство по работе с Git
Задание 1. Установка и первые шаги с Git
Задание 2. Продвинутая работа в терминале
Работа с VS Code
Задание 3. Установка VS Code и первая работа с проектом
03Публикация документации с Docusaurus
⌄
Docusaurus: что это и как устроен проект
Навыки техписателя и процесс публикации
Тест 2. Вопросы по работе с Docusaurus
Работа с npm
Задание 4. Установка npm и первый запуск документации
04Обзор учебного репозитория
⌄
Учебный репозиторий «Экспресс сервис»: знакомство и структура
Документация для пользователей и справочник API
05Работа с пользовательской документацией
⌄
Оформление текста: MDX и HTML
Навигация: как устроен сайдбар
Задание 5. Настройка навигации
Задание 6. Оформление текста
Структурирование документации
Переиспользование контента
Задание 7. Структурирование страницы «Оплата и тарифы»
Задание 8. Работа со сниппетами
06Работа с API
⌄
Интерактивный API в учебном репозитории
Что такое API и типы веб-API
REST API и инструменты для работы с API
Тест 3. Вопросы по разделу «Работа с API»
Задание 9. Первое знакомство с API
Как устроен файл OpenAPI
Задание 10. Исправление синтаксиса
Задание 11. Документирование нового метода
Задание 12. Дополнение кодов ошибок
Задание 13. Обновление главной страницы API
Задание 14. Документирование метода «Список заказов»

Записаться на курс

Учиться можно сразу после оплаты

25 000 ₽
Обратная связь куратора по каждому заданию
Доступ к учебному репозиторию «Экспресс сервис»
Портфолио на GitHub и сертификат

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

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

Контакты и правовая информация
Оферта
Политика обработки персональных данных
Made on
Tilda