Назначение#

Platform V GetDocs представляет собой инструмент для разработки документации в парадигме Docs as code (документация как код) и сайт документации.

• Продукт предназначен для команд разработки в компаниях - разработчиках ПО. Обеспечивает эффективное технологичное производство документации полного цикла от работы с исходными кодами до публикации готовой документации для пользователей.

• Поддерживает жизненный цикл разработки документации.

• Позволяет преобразовывать исходный код документации из разных источников в выходные форматы для пользователей (читателей).

• Обеспечивает валидацию документации при разработке, в том числе по настраиваемым правилам на основе стайлгайдов компании.

• Предоставляет хранилище готовой документации и веб-сайт для отображения документации.

• Позволят синхронизировать контент между несколькими инсталляциями, например внутренним и внешним сайтами документации компании.

• Предоставляет AI-инструменты перевода документации.

Состав продукта#

В состав Platform V GetDocs (GDC) входят следующие компоненты:

• GetDocs Engine (GDCE)

• GetDocs Site (GDCS)

GetDocs Engine (GDCE)#

Данный компонент отвечает за формирование документации в виде статического сайта, валидацию контента документации, выгрузку документации форматах PDF и DOCX и представление API компонентов в формате Swagger.

GetDocs Site (GDCS)#

Данный компонент представляет собой веб-сайт, на котором отображается собранная документация для пользователей с возможностью поиска.