Документация приложения

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

Порядок работы

1. Откройте приложение и перейдите в раздел «Документация».
2. Добавьте материалы: папки, Markdown-страницы, документы, изображения, таблицы или ZIP-архив.
3. Подготовьте языковые версии Markdown-страниц на русском, английском или обоих языках.
4. Расположите папки и страницы в том порядке, в котором они должны отображаться в боковом меню.
5. Настройте публичный адрес и проверьте документацию так, как её увидит пользователь.
6. При необходимости используйте поиск по документации на сайте, в агентах и MCP-клиентах.

Выберите задачу

• Материалы и структура — добавление файлов и ZIP, распознавание изображений, папки и перетаскивание страниц.
• Языки и переводы — русская и английская версии одной страницы, сохранение и удаление перевода.
• Публикация — slug, публичная ссылка, доступность, внешний вид и поддерживаемые форматы.
• Поиск — какие приложения входят в общий поиск и как использовать search_documentation.

Хранение и права

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

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