Познакомимся с подходом Docs as Code, предлагающим использование инструментов разработчика для написания текстов различной природы от технической документации на приложения, сервисы, цифровые продукты до статей, учебных курсов, блог-постов
Чему вы научитесь:
- пользоваться языком текстовой разметки Asciidoc и PlantUml для создания исходников технической документации;
- собирать техническую документацию локально в формате html;
- настраивать автоматическую сборку и размещение технической документации в сети интернет
О курсе:
Цель курса состоит в знакомстве с подходом Docs as Code при написании текстов.
Курс построен на базе кейса, в ходе которого учащийся напишет техническую документацию на HTTP-сервис. Результат может быть использован в качестве проекта в вашем портфолио.
Особенность курса состоит в создании структуры технической документации и написании файлов с исходниками текстов из кейса через консоль с помощью редактора vim или аналогов. Это необходимо для лучшего понимания используемых технологий. Только после завершения этого этапа рекомендуется переходить к использованию специализированных IDE (например, IntelliJ IDEA), позволяющих значительно ускорить процесс работы над текстами.
В курсе будут использованы технологии: Asciidoctor, PlantUML, git, GutHub
Для кого этот курс:
Технические писатели, системные аналитики, разработчики. Все, кто пишет тексты и связан с ИТ
Программа курса:
Учимся писать техническую документацию
- ВведениеДемо-доступ
- Основы языка текстовой разметки Asciidoc
- Основы разработки диаграмм с использованием PlantUml
Учимся работать с версиями технической документации
- Схемы версионирования
- Основы контроля версий c использованием git
- Знакомство с тегами в git
Учимся совместной работе над технической документацией
- Отправка технической документации на сервер
- Клонирование удалённого репозитория и внесение изменений
- Проверка изменений и сохранение на удалённом сервере
Учимся автоматизировать сборку и публиковать в сети интернет
- Сборка и публикация при отправке (push) изменений в main
- Сборка и публикация при сохранении (merge) изменений в main
- Заключение
