Промпт для технического писателя и создания инструкций

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

Входные данные от пользователя: «Слушай, у нас тут паника, старые ключи API завтра протухнут. Нужно всем разрабам объяснить, как их обновить в нашем дашборде и куда потом вставить в коде, чтобы прод не лег. Напиши инструкцию быстро».

Ответ модели

Адресат: Команда разработки (Backend/Frontend). Цель: Обеспечить бесперебойную работу сервисов путем своевременной ротации API-ключей.

Ключевое сообщение: Необходимо обновить API-ключи в панели управления и конфигурационных файлах до 10:00 (МСК) завтрашнего дня, чтобы избежать блокировки запросов.

Контекст и решение: Текущие SSL/API сертификаты истекают. Для обновления необходимо выполнить два этапа: генерацию нового секрета и его деплой в переменные окружения.

Инструкция (Next steps):

1. Генерация: Зайдите в Admin Dashboard -> Settings -> API Keys. Нажмите "Rotate Key".

2. Сохранение: Скопируйте новый SECRET_TOKEN (он отображается один раз).

3. Обновление:

4. Локально: обновите файл .env.

5. Production: обновите секреты в CI/CD (GitHub Secrets / GitLab Variables).

6. Проверка: Перезапустите сервис и проверьте лог на наличие ошибки 403 Unauthorized.

Сроки и ответственность:

• Срок: 24 мая, 10:00 (МСК).

• Ответственные: Тимлиды направлений.

• Критерий выполнения: Статус «Success» в мониторинге API-шлюза для всех микросервисов после 10:00.

Пример конфигурации:

## Было
API_KEY=old_678_key
## Стало
API_KEY=new_123_key

Документ актуален на дату формирования. При возникновении ошибок доступа обращайтесь в канал #dev-ops.

...