Основные функции#

Продукт Platform V GetDocs (GDC) предоставляет следующие основные функции:

Наименование функции	Потребитель функции	Аргументы функции	Результат
Конфигурирование состава документации на сайте	Администратор АС	Общие параметры отображения документации Параметры конкретного комплекта документации	Применены параметры отображения контента на сайте
Ведение правил валидации контента	Администратор АС	Правило валидации контента	Правило валидации контента добавлено, отредактировано или удалено
Ведение продуктового учета	Администратор АС	Название продукта Параметры продукта	Информация о продукте добавлена, изменена или удалена
Конфигурация комплекта документации	Пользователь	Конфигурационный файл	Параметры, указанные в конфигурационном файле, применяются при сборке сайта и дистрибутива документации
Сборка API документации: * Вручную * Из Git * Из Nexus CI	Пользователь	Метаинформация об API Спецификация API Атрибуты доступа к внешнему хранилищу API	Сгенерированная документация API в формате Swagger
Добавление документа в определенную группу	Пользователь	Документ Имя группы документов	При сборке сайта документации документ отображается в указанной группе
Работа с workflows	Пользователь	Тип workflow Параметры запуска Артефакты выполнения	Workflow запущен с учетом указанных параметров, сгенерированы и проанализированы результаты его выполнения
Запуск workflow	Пользователь	Тип workflow Параметры запуска	Выбранный workflow запущен с учетом указанных параметров
Сборка документации	Пользователь	Workflow `build-doc` Исходный код документации в git-репозитории	Собран предварительный комплект документации в HTML-формате
Сборка сайта	Пользователь	Workflow `build-site` Конфигурация сайта	Предварительно собранные комплекты документации, указанные в конфигурации сайта, отображаются на сайте
Создание и загрузка дистрибутива в Nexus	Пользователь	Workflow `load-to-nexus` Параметры комплекта документации на сайте	Комплект документации выгружен как артефакт в Nexus-репозиторий
Базовая валидация документации	Пользователь	Workflow `validate-doc` Исходный код документации в git-репозитории	Получен отчет валидации исходного кода документации
Валидация документации с применением AI-инструментов	Пользователь	Workflow `validate-image`/`validate-system-requirements` Исходный код документации в git-репозитории Список разрешенного программного обеспечения	Получен отчет валидации изображений и упоминаемого в документации ПО
Перевод документации с применением AI-сервиса	Пользователь	Инструмент перевода Сайт с документацией на языке оригинала	Сгенерированы Markdown-файлы с переведенной документацией
Выгрузка печатных форм	Пользователь	Workflow `print-doc` Исходный код документации в git-репозитории	Сгенерированы PDF или DOCX-файлы из исходного кода документации
Просмотр всех отчетов сборки	Пользователь	-	Пользователю доступны результаты запуска всех workflow
Работа с отчетом сборки или валидации документации	Пользователь	Отчет сборки или валидации документации	Анализ результатов сборки и валидации исходного кода документации, исправление найденных ошибок
Просмотр ошибок	Пользователь	Отчет выполнения workflow	Пользователю доступны логи и отчет выполнения workflow с указанными ошибками
Перезапуск workflow	Пользователь	Успешно или неуспешно завершившийся workflow	Выбранный workflow перезапущен с прежними или новыми параметрами
Просмотр документации на сайте	Пользователь	-	Документация доступна для просмотра на сайте
Поиск информации на сайте с помощью AI-ассистента	Пользователь	Поисковый запрос	В чате с ассистентом доступна ссылка на страницу с информацией, найденной по поисковому запросу