Что подготовить
- Исходный код
- Описания API
- Правила документации
Уточняем формат, актуальность и доступность этих материалов на обследовании.
Агент документации ПО
Подготавливает понятные технические описания по фактическому устройству системы и её интерфейсам.
Задача и результат для команды
Подготовка технических описаний. Этот сценарий встраивается в ваш процесс с согласованными источниками, правами и правилами передачи сотруднику.
Проект документации с рабочими примерами
Примеры проверяются; неизвестное поведение не объявляется поддерживаемой функцией.
Как работает Агент документации ПО
Собрать сведения
Составить структуру
Проверить примеры
С чем можно связать
- Service Desk
- Мониторинг
- Репозитории и CI
Состав обмена зависит от доступных интерфейсов, прав и условий выбранных сервисов.
Как это выглядит на практике
С чем приходит пользователь
После релиза нужно обновить описание нового API-метода.
Что получает команда
Команда получает параметры, ответы и ограничения, связанные с реальной реализацией.
Начинаем с проверяемого пилота
Согласуем один рабочий маршрут, подготовим контрольные примеры и проверим результат до расширения. Измеряем: соответствие документации реализации.
Что важно проверить
Примеры проверяются; неизвестное поведение не объявляется поддерживаемой функцией.
Изменение конфигураций и выпуск релизов проходят обычные проверки и согласования команды.
Данные, подключения и правила
Обследование задачи, подготовка материалов, настройка сценария, интеграция согласованных систем и приёмка на контрольных примерах.
Стоимость рассчитываем по объёму задачи, подключениям и условиям сопровождения после обследования.
Вопросы об агенте
Какие данные подготовить для запуска?
Исходный код, Описания API, Правила документации. На обследовании уточним формат, актуальность материалов и права доступа. Для первого пилота подбираем контрольные примеры из вашего процесса.
Что получает сотрудник в результате?
Проект документации с рабочими примерами. Команда получает параметры, ответы и ограничения, связанные с реальной реализацией.
Как проверить качество работы агента?
Критерий пилота: соответствие документации реализации. Примеры проверяются; неизвестное поведение не объявляется поддерживаемой функцией.
Другие агенты направления
Обсудим, как внедрить агента
Расскажите, какие материалы и системы уже используются. Определим возможности, результат пилота и порядок оценки стоимости.
Обсудить задачу ↗