Автор: Алексей Лобзов
Docs as Code: Пишем тексты как код

Познакомимся с подходом Docs as Code, предлагающим использование инструментов разработчика для написания текстов различной природы от технической документации на приложения, сервисы, цифровые продукты до статей, учебных курсов, блог-постов

Чему вы научитесь:

  • пользоваться языком текстовой разметки Asciidoc и PlantUml для создания исходников технической документации;
  • собирать техническую документацию локально в формате html;
  • настраивать автоматическую сборку и размещение технической документации в сети интернет

О курсе:

Цель курса состоит в знакомстве с подходом Docs as Code при написании текстов.

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

Особенность курса состоит в создании структуры технической документации и написании файлов с исходниками текстов из кейса через консоль с помощью редактора vim или аналогов. Это необходимо для лучшего понимания используемых технологий. Только после завершения этого этапа рекомендуется переходить к использованию специализированных IDE (например, IntelliJ IDEA), позволяющих значительно ускорить процесс работы над текстами.

В курсе будут использованы технологии: Asciidoctor, PlantUML, git, GutHub

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

Технические писатели, системные аналитики, разработчики. Все, кто пишет тексты и связан с ИТ

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

Учимся писать техническую документацию

  1. ВведениеДемо-доступ
  2. Основы языка текстовой разметки Asciidoc
  3. Основы разработки диаграмм с использованием PlantUml

Учимся работать с версиями технической документации

  1. Схемы версионирования
  2. Основы контроля версий c использованием git
  3. Знакомство с тегами в git

Учимся совместной работе над технической документацией

  1. Отправка технической документации на сервер
  2. Клонирование удалённого репозитория и внесение изменений
  3. Проверка изменений и сохранение на удалённом сервере

Учимся автоматизировать сборку и публиковать в сети интернет

  1. Сборка и публикация при отправке (push) изменений в main
  2. Сборка и публикация при сохранении (merge) изменений в main
  3. Заключение
Дата последнего обновления: 22 января 2024

Темы

Другие курсы

-20%
PRO Логические задачи
PRO Логические задачи
Авторы: Александр Павлович, Иосиф Дзеранов
Подробнее
3 992
4 990
998
/мес
Тестирование ПО: Автоматизация и Программирование. Python. Selenium
Тестирование ПО: Автоматизация и Программирование. Python. Selenium
Автор: Алекс Смит
Тестирование ПО с Нуля до Специалиста
Тестирование ПО с Нуля до Специалиста
Автор: Алекс Смит
Git для всех
Git для всех
Автор: Татьяна Овчинникова
-82%
Специалист по информационной безопасности: веб-пентест
Специалист по информационной безопасности: веб-пентест
Авторы: Группа авторов
Подробнее
23 500
135 000
-20%
Продвинутый курс по Javascript
Продвинутый курс по Javascript
Автор: Кирилл Поздняков
Подробнее
3 970
4 980
Алгоритмы на Python с Глебом Михайловым
Алгоритмы на Python с Глебом Михайловым
Аналитик с нуля. Старт в профессии
Аналитик с нуля. Старт в профессии
Автор: Ольга Пономарева
Excel для работы с нуля
Excel для работы с нуля
Авторы: Марк Сысоев, Данила Елистратов
Назад
Смотреть дальше