Рекомендации по работе с модулем "DevOps Documentation"

Модуль «DevOps Documentation» предназначен для централизованного хранения и создания документации для DevOps-инженеров. Он представлен категорией «DevOps документация».

Здесь мы собрали некоторые рекомендации по использованию модуля.

Структура

Используйте элемент «Папка (к)» для объединения инструкций по модулям, проектам или другим группирующим атрибутам;

Внутри папок можно создавать другие папки для дополнительной вложенности документации.

Создание документации

Система Bizon имеет встроенный текстовый редактор с функционалом, достаточным для написания и оформления документации. Также вы можете загружать в систему уже готовые документы.

Как добавить документ:

1. Создайте документ в соответствующей папке;
2. Разверните информационные блоки;
3. В блоке «Файлы» нажмите кнопку вызова контекстного меню;
4. Нажмите «Создать файл» или «Загрузить файл».

Связи

Связывайте документацию с проектами, к которым она относится (категория «Проекты»). Благодаря этому вы сможете перейти от проекта ко всей необходимой документации по нему.

При необходимости вы можете связать элемент документации с сервером или микросервисом. Эта связь будет отображаться в приложении «Данные» документа и в приложениях «Документы» и «Реестр связей» сервера или микросервиса.