К содержимому
Все материалы

Как быстрее найти ответ в документации Akmelo

Руководство, API и SDK отвечают на разные вопросы. Рассказываем, как сформулировать запрос, выбрать версию и перейти от найденной статьи к действию.

Редакция AkmeloО продукте и работе с данными
Открытая светлая книга, несколько листов и небольшая закладка на синем фонеИзображение недоступно

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

Вместо «ничего не работает» попробуйте «как посмотреть ошибку прогона» или «как передать вложенные поля в JSON». По такому запросу проще выбрать подходящий раздел.

Выберите подходящий раздел

У документации Akmelo есть общая главная с поиском, руководство, справочник API и описание SDK. Они отвечают на разные вопросы. Руководство объясняет работу в интерфейсе, API описывает обращение к сервису из другой программы, а SDK нужен при написании сценария сбора.

Если вы только начинаете, откройте путь к первому результату. Для конкретной проблемы переходите сразу к задаче: источник, сценарий, прогон, расписание или выгрузка. Необязательно читать технический справочник целиком, чтобы разобраться с одной настройкой.

На главной можно искать по опубликованной документации выбранной версии. Сначала сформулируйте действие и предмет: «переименовать поле выгрузки» обычно полезнее, чем просто «поле». Если нужного результата нет, попробуйте термин из интерфейса или более короткий вопрос.

Читайте ответ вместе с условиями

Найденный пример стоит проверять целиком. У операции могут быть требования к правам, подготовке данных или выбранному режиму. Короткий фрагмент из поиска помогает выбрать статью, но не заменяет объяснение вокруг него.

Посмотрите и на версию документации. Выбранный выпуск сохраняется при переходах, поэтому ссылка от коллеги может вести к более раннему описанию. Перед настройкой убедитесь, что читаете нужный выпуск. Если сравниваете поведение с интерфейсом, запишите, на какой статье и версии основан ваш вопрос.

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

После чтения вернитесь к небольшой проверке в приложении: откройте пример выгрузки, изучите журнал или выполните пробный сбор. Для данных перед передачей пригодится наша редакционная памятка о проверке выгрузки. Если вопрос остался, запишите, какой шаг вы выполнили и что получили вместо ожидаемого. Этот пример будет полезен при следующем поиске или обсуждении с коллегой.