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

vitriol0674

Команда форума
Разула в сердце
Живёт по соседству
Особенный
Спасибо от Разулы
Регистрация
13 Янв 2018
Сообщения
44.311
Реакции
733.212
Ra
141.242
Docs as Code: Пишем тексты как код [Stepik]
1714337388293.png
Познакомимся с подходом 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. Заключение
16,7 Мб.

Скачать:
 

Похожие темы

Теги по которым нашли тему

  1. Stepik
  2. vim
Сверху