Документы как код: современная техническая документация с использованием Git и автоматизации

Трудно ли поддерживать техническую документацию, подвержена ли она ошибкам и не связана ли она с кодом, который она описывает? Подход Docs as Code решает эти общие проблемы, интегрируя документации в стандартный жизненный цикл разработки программного обеспечения. Применяя такие принципы проектирования, как управление версиями и автоматизация, вы создадите надежный, масштабируемый и совместный рабочий процесс документации. Вы научитесь использовать стандартные инструменты для управления контентом, обеспечения качества и автоматической публикации документации при слиянии изменений. Что вы узнаете: * Понять основные принципы и преимущества Docs как философии кода и шаблонов рабочего процесса. * Master расширенный синтаксис Markdown и структурирование содержания для удобочитаемости и долгосрочной обслуживаемости. * Применять Git и методы управления версиями для эффективного сотрудничества и управления всеобъемлющей историей документов. * Настройка генератора статических сайтов (SSG) для преобразования необработанных исходных файлов в готовые к выпуску веб-сайты документации. * Внедрение основ непрерывной интеграции и развертывания (CI / CD) для автоматизированного создания и публикации. * Практика интеграции базовых проверок качества, таких как очистка от пыли, для поддержания согласованности и стандартов документации. Курс начинается с определения ключевых концепций Docs as Code, затем шаг за шагом проходит настройку вашей среды, овладение основами Markdown и Git, настройка SSG и, наконец, создание полного автоматизированного рабочего процесса CI / CD для развертывания. Этот курс предназначен для технических писателей, создателей контента и разработчиков, которые впервые знакомятся с современными методами документации. Не требуется предыдущий опыт работы с Git или CI / CD, только базовое удобство с письменным текстом и программными инструментами. Начните создавать профессиональную, надежную техническую документацию сегодня.