Варианты и сценарии использования#

Варианты использования#

Продукт Platform V GetDocs (GDC) обладает следующими вариантами использования.

Администратор АС#

Пользователь#

Сценарии использования#

1. Конфигурирование состава документации на сайте#

Актор: Администратор АС.

Описание: Администратор редактирует конфигурацию сайта, которая хранится в отдельном репозитории:

• формирует список комплектов документации для публикации на сайте,

• указывает целевое пространство публикации,

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

Предусловия: У администратора АС есть доступ на запись в репозитории конфигурации сайта.

Основной поток событий:

1. Администратор АС открывает репозиторий с конфигурацией сайта.

2. Администратор АС указывает в главном конфигурационном файле сайта правила группировки документов, доступные пространства публикации и прочие общие настройки.

3. Администратор АС формирует список версий и продуктов, подлежащих публикации на сайте.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: Администратор АС не имеет прав на запись в репозитории конфигурации сайта.

Результат: Сайт отображается в соответствии с настройками в конфигурационных файлах.

2. Ведение правил валидации контента#

Актор: Администратор АС.

Описание: Администратор редактирует и включает необходимые правила валидации контента, которые хранятся в отдельном репозитории.

Предусловия: У администратора АС есть доступ на запись в репозитории правил валидации.

Основной поток событий:

1. Администратор АС открывает репозиторий с правилами валидации контента.

2. Администратор АС создает новые и редактирует или удаляет существующие правила валидации.

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

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: Администратор АС не имеет прав на запись в репозитории конфигурации сайта.

Результат: Отчет сборки и валидации документации формируется с учетом изменений, внесенных в репозитории с правилами валидации контента.

3. Ведение продуктового учета#

Актор: Администратор АС.

Описание: Администратор редактирует продуктовый учет, в котором отражен список продуктов с их названиями и условными кодами, а также группы, в которых должна размещаться их документация на сайте.

Предусловия: У администратора АС есть доступ на запись в репозитории конфигурации сайта.

Основной поток событий:

1. Администратор АС открывает репозиторий с конфигурацией сайта.

2. Администратор АС формирует список продуктов и соотносит их в группами отображения контента на сайте.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: Администратор АС не имеет прав на запись в репозитории конфигурации сайта.

Постусловия: Сайт отображается в соответствии с настройками, заданными в продуктовом учете.

4. Конфигурация комплекта документации#

Актор: Пользователь.

Описание: Пользователь настраивает структуру комплекта и конфигурационный файл документации.

Предусловия: У пользователя есть доступ на запись в репозитории документации.

Основной поток событий:

1. Пользователь актуализирует конфигурацию комплекта документации для текущего релиза.

2. Пользователь при необходимости актуализирует структуру файлов содержания разделов.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: Пользователь не имеет прав на запись в репозитории документации.

Постусловия: Конфигурационный файл и файлы содержания разделов содержат актуальную информацию для текущего релиза.

5. Сборка API документации#

Актор: Пользователь.

Описание: Пользователь указывает в конфигурационном файле информацию о публичных API.

Предусловия: У пользователя есть доступ на запись в репозитории документации.

Основной поток событий:

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

2. Пользователь запускает сборку комплекта документации.

Альтернативные потоки событий:

• 5.1. Вручную Пользователь добавляет в репозиторий JSON-файл с описанием публичных API.

• 5.2. Из Git Пользователь добавляет в репозиторий JSON-файл с указанием репозитория, из которого нужно собрать API документацию.

• 5.3. Из Nexus CI Пользователь добавляет в репозиторий JSON-файл координаты API документации в Nexus.

Ошибочные потоки событий: Пользователь не имеет прав на запись в репозитории документации.

Постусловия: Документация на сайте содержит описания API.

6. Добавление документа в определенную группу#

Актор: Пользователь.

Описание: Пользователь указывает группу, в какую должен попасть определенный документ.

Предусловия: У пользователя есть доступ на запись в репозитории документации.

Основной поток событий: Пользователь указывает в YAML-заголовке файла документации группу, в какой текущий документ должен отобразиться на сайте.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: Пользователь не имеет прав на запись в репозитории документации.

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

7. Работа с workflows#

8. Запуск workflow#

Актор: Пользователь.

Описание: Пользователь запускает workflow для комплекта документации.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Репозиторий документации сконфигурирован для сборки.

Основной поток событий:

1. Пользователь выбирает необходимый workflow.

2. Пользователь указывает параметры workflow при необходимости.

3. Пользователь запускает workflow.

Альтернативные потоки событий:

• Запуск workflow сборки комплекта документации

• Запуск workflow сборки сайта

• Запуск workflow создания и загрузки дистрибутива в Nexus CD

• Запуск workflow сборки валидации документации

• Запуск workflow выгрузки печатных форм

Ошибочные потоки событий:

• У пользователя нет доступа в Argo Workflows.

• Репозиторий документации не сконфигурирован для сборки или сконфигурирован с ошибками.

Постусловия: Workflow успешно завершил выполнение.

8.1. Сборка документации#

Актор: Пользователь.

Описание: Пользователь запускает workflow для сборки комплекта документации.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Репозиторий документации сконфигурирован для сборки.

Основной поток событий:

1. Пользователь выбирает workflow сборки документации.

2. Пользователь указывает параметры workflow при необходимости.

3. Пользователь запускает workflow сборки документации.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий:

• У пользователя нет доступа в Argo Workflows.

• Репозиторий документации не сконфигурирован для сборки или сконфигурирован с ошибками.

Постусловия:

• Workflow сборки документации успешно завершил выполнение.

• Доступен собранный временный предпросмотр документации.

• Сгенерирован отчет сборки контента.

8.2. Сборка сайта#

Актор: Пользователь.

Описание: Пользователь запускает workflow для сборки комплекта документации.

Предусловия: У пользователя есть доступ в Argo Workflows.

Основной поток событий:

1. Пользователь выбирает workflow сборки сайта.

2. Пользователь запускает workflow сборки сайта.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий:

• У пользователя нет доступа в Argo Workflows.

• Произошла ошибка сборки сайта.

Постусловия:

• Workflow сборки сайта успешно завершил выполнение.

• Сайт обновлен в соответствии с его конфигурацией.

• Сгенерирован отчет сборки сайта.

8.3. Создание и загрузка дистрибутива в Nexus CD#

Актор: Пользователь.

Описание: Пользователь запускает workflow для загрузки дистрибутива документации в Nexus CD.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Техническая учетная запись Argo Workflows имеет право на запись в Nexus репозитории, где будет размещен дистрибутив.

Основной поток событий:

1. Пользователь выбирает workflow загрузки дистрибутива документации.

2. Пользователь указывает условный код и версию комплекта документации, которую необходимо выгрузить в Nexus CD.

3. Пользователь запускает workflow загрузки дистрибутива документации.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий:

• У пользователя нет доступа в Argo Workflows.

• Техническая учетная запись Argo Workflows не имеет права на запись в Nexus репозитории, где должен быть размещен дистрибутив.

• Произошла ошибка загрузки дистрибутива документации.

Постусловия:

• Workflow загрузки дистрибутива документации успешно завершил выполнение.

• Дистрибутив размещен в указанном Nexus репозитории.

8.4. Валидация документации (Базовая и с использованием AI-инструментов)#

Актор: Пользователь.

Описание: Пользователь запускает workflow валидации контента документации.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Репозиторий документации сконфигурирован для работы с workflows.

Основной поток событий:

1. Пользователь выбирает workflow валидации контента документации.

2. Пользователь указывает параметры workflow при необходимости.

3. Пользователь запускает workflow валидации контента документации.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий:

• У пользователя нет доступа в Argo Workflows.

• Репозиторий документации не сконфигурирован для работы с workflows или сконфигурирован с ошибками.

Постусловия:

• Workflow валидации контента документации успешно завершил выполнение.

• Сгенерирован отчет валидации контента.

8.5 Выгрузка печатных форм#

Актор: Пользователь.

Описание: Пользователь запускает workflow для генерации DOCX или PDF файлов из исходных кодов документации.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

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

Основной поток событий:

1. Пользователь выбирает workflow генерации DOCX или PDF файлов из исходных кодов документации.

2. Пользователь указывает условный код и версию комплекта документации, которую необходимо выгрузить в DOCX или PDF, и другие параметры при необходимости.

3. Пользователь запускает workflow генерации DOCX или PDF файлов из исходных кодов документации.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий:

• У пользователя нет доступа в Argo Workflows.

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

Постусловия:

• Workflow генерации DOCX или PDF файлов из исходных кодов документации успешно завершил выполнение.

• Архив со сгенерированными документами доступен к скачиванию.

9. Просмотр всех отчетов сборки#

Актор: Пользователь.

Описание: Пользователь просматривает список всех отчетов сборки.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Был успешно завершен workflow сборки документации.

Основной поток событий:

1. Пользователь открывает успешно завершившийся workflow сборки документации.

2. Пользователь открывает выходные артефакты сборки.

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

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: У пользователя нет доступа в Argo Workflows.

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

9.1. Работа с отчетом сборки или валидации документации#

Актор: Пользователь.

Описание: Пользователь просматривает и анализирует отчет сборки или валидации документации.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Был завершен workflow сборки или валидации документации.

Основной поток событий:

1. Пользователь открывает завершившийся workflow сборки или валидации документации.

2. Пользователь открывает отчет сборки или валидации документации.

3. Пользователь анализирует отчет на предмет наличия и устранения ошибок и предупреждений.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: У пользователя нет доступа в Argo Workflows.

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

10. Просмотр ошибок#

Актор: Пользователь.

Описание: Пользователь просматривает отчет workflow, завершившегося с ошибкой.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Workflow был завершен с ошибкой.

Основной поток событий:

1. Пользователь открывает workflow, завершившийся с ошибкой.

2. Пользователь просматривает отчет и анализирует способы устранения ошибок.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: У пользователя нет доступа в Argo Workflows.

Постусловия: Пользователю доступен отчет workflow, завершившегося с ошибкой.

11. Перезапуск workflow#

Актор: Пользователь.

Описание: Пользователь перезапускает workflow, завершенный ранее.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Ранее был завершен workflow.

Основной поток событий:

1. Пользователь выбирает необходимый workflow, завершившийся ранее.

2. Пользователь открывает форму перезапуска workflow.

3. Пользователь указывает параметры workflow при необходимости.

4. Пользователь запускает workflow.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: У пользователя нет доступа в Argo Workflows.

Постусловия: Workflow успешно перезапущен.

12. Просмотр документации на сайте#

Актор: Пользователь.

Описание: Пользователь просматривает документацию на сайте.

Предусловия: Сайт документации сконфигурирован и собран.

Основной поток событий:

1. Пользователь открывает сайт документации.

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

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: Отсутствуют.

Постусловия: Пользователю доступен сайт с документацией.

13. Поиск информации на сайте с помощью AI-ассистента#

Актор: Пользователь.

Описание: Пользователь отправляет вопрос ассистенту через чат на сайте.

Предусловия: Сайт документации сконфигурирован и собран.

Основной поток событий:

1. Пользователь открывает сайт документации.

2. Пользователь открывает чат с ассистентом и вводит вопрос в свободной форме.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий: Отсутствуют.

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

14. Перевод документации с помощью AI-сервиса#

Актор: Пользователь.

Описание: Пользователь запускает workflow перевода документации.

Предусловия:

• У пользователя есть доступ в Argo Workflows.

• Репозиторий документации сконфигурирован для работы с workflow перевода.

Основной поток событий:

1. Пользователь выбирает workflow перевода документации.

2. Пользователь указывает параметры workflow при необходимости.

3. Пользователь запускает workflow перевода документации.

Альтернативные потоки событий: Отсутствуют.

Ошибочные потоки событий:

• У пользователя нет доступа в Argo Workflows.

• Репозиторий документации не сконфигурирован для работы с workflow или сконфигурирован с ошибками.

Постусловия:

• Workflow перевода документации успешно завершил выполнение.

• Сгенерированы файлы с переводами документации, готовые к публикации.