Docs as Code: Пишем тексты как код

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

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

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

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

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

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

Начальные требования

• опыт работы с *nix системами;
• базовые знания bash;
• понимание технологии git;
• знания английского, достаточные для чтения технической литературы