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