Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 2.8 KB

README.md

File metadata and controls

41 lines (21 loc) · 2.8 KB

Публикация документации

Документация по API часто соответствует принципу docs-as-code, где инструменты для создания и публикации документации тесно связаны с теми же инструментами, которые разработчики используют для написания, управления, построения и развертывания кода.

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

Содержание модуля "Публикация документации"

Обзор вариантов публикации документации

Список из 100 сайтов с API документацией

Шаблоны проектирования сайтов API документации

Инструменты Docs-as-code

Подробнее о Markdown

Система контроля версий (пример Git)

Практическое занятие: Управляем контентом в Wiki Github

Практическое занятие: Используем клиент GitHub для десктопа

Практическое занятие: процесс Pull request на GitHub

Генераторы статичных сайтов

Варианты хостинга и развертывания

Возможности автономных CMS

Рекомендации - какой инструмент документирования выбирать

Непрерывное развертывание Jekyll и CloudCannon

Кейс для изучения: Переход на Docs-as-code

🔙

Go next ➡