Documentat.io

О чем этот курс?

Docs as Code — современная технология и философия разработки технической документации. Используют ее везде: от корпораций и опенсорсных проектов мирового уровня до гаражных стартапов. Крупным командам она позволяет держать под контролем масштабные документационные проекты, небольшим — сделать документирование посильной задачей. Количество вакансий, в которых требуется владение Docs as Code, растет год от года.

Для кого этот курс?

Курс адресован техническим писателям, которым необходимо быстро освоить основы Docs as Code.

После курса вы сможете полноценно участвовать в проектах, где используются этот подход.

Что получат слушатели?

• Ментальная модель Docs as Code.
• Навыки работы с опорным стеком — Markdown, VS Code, Git и GitHub.
• Кругозор: инструменты, подходы, надстройки и расширения.
• Мини-проект, созданный с помощью Docs as Code — собственный сайт-визитка.

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

• Концепция Docs as Code. Особенности и сильные стороны подхода. Ограничения подхода и ситуации, в которых его применение может быть избыточным.
• Легковесные языки разметки. Синтаксис, диалекты и расширения Markdown. Особенности reStructuredText и AsciiDoc.
• Специализированные текстовые редакторы. VS Code. Основные функции, навигация, терминал. Самое нужное для техписателя.
• Генераторы статических сайтов. Как из md-файлов получается готовый сайт. VitePress. Обзор популярных инструментов: Docusaurus, Hugo, Astro, Diplodoc, Sphinx.
• Система контроля версий. Git с нуля: репозиторий, коммиты, история, ветки, слияние.
• Платформы хостинга кода. GitHub и GitLab: репозитории, issues, pull requests, превью. Как устроена командная работа над документацией.
• CI/CD для документации. Автоматическая сборка и публикация при каждом изменении. Автоматические проверки. Настройка пайплайна.
• Жизненный цикл изменений. Путь правки от задачи до публикации. Процедура ревью.
• Участие в open source проектах. Fork. Как найти проект и подходящую задачу. Лучшие проекты для первого вклада.

Формат курса

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

Занятия проходят онлайн. Преподаватель показывает рабочий процесс на экране, после чего слушатели выполняют задания в учебном или публичном проекте. Для участия потребуются Zoom, Telegram. Список других инструментов будет опубликован заранее.