Skip to content

knowledge.md

Latest commit

 

History

History
196 lines (133 loc) · 9.04 KB

knowledge.md

File metadata and controls

196 lines (133 loc) · 9.04 KB
Raw

📚 Центральный узел знаний: Разработка приложений Битрикс24

🎯 Назначение

Этот файл является центральным узлом знаний для AI-агентов, работающих с приложениями Битрикс24. Содержит только языково-агностическую информацию и ссылки на специализированные разделы.

🏗️ Архитектура системы знаний

knowledge.md (этот файл) - центральный узел
├── backend/
│   ├── php/knowledge.md
│   ├── python/knowledge.md
│   └── node/knowledge.md
├── frontend/knowledge.md
└── queues/
    ├── server.md
    ├── php.md
    ├── python.md
    └── node.md

🌐 Общая архитектура приложений Битрикс24

Проект содержит "заготовку" приложения, использующего упрощенную авторизацию OAuth 2.0 с получением токенов во время установки приложения на портал Битрикс24.

Приложение базово устанавливает ряд виджетов - встройку в карточку сделки и встройку в виде пользовательского типа поля в CRM.

Компоненты системы

REST API

  • Единая точка доступа ко всем данным портала
  • OAuth 2.0 авторизация для приложений
  • Webhook-уведомления для событий
  • Batch-запросы для оптимизации производительности

Bitrix24 JavaScript SDK

  • Клиентская библиотека для работы с API
  • Управление интерфейсом портала
  • Обработка событий пользовательского интерфейса

UI Kit и дизайн-система

  • Компоненты интерфейса в стиле Битрикс24
  • Consistent UI/UX across applications
  • Responsive design principles

📊 Основные сущности CRM

Лиды (Leads)

  • Потенциальные клиенты
  • Первичная точка контакта
  • Конверсия в сделки или контакты

Сделки (Deals)

  • Коммерческие возможности
  • Воронка продаж с стадиями
  • Привязка к контактам и компаниям

Контакты (Contacts)

  • Физические лица - клиенты
  • Персональная информация
  • История взаимодействий

Компании (Companies)

  • Юридические лица - клиенты
  • Корпоративная информация
  • Связь с контактами

Активности (Activities)

  • Звонки, встречи, задачи
  • Планирование и история
  • CRM аналитика

🔧 Выбор технологического стека

Backend разработка

PHP

➡️ См. подробности: php/knowledge.md

Python

➡️ См. подробности: python/knowledge.md

Node.js (рекомендуется для full-stack JS)

➡️ См. подробности: node/knowledge.md

Frontend разработка

Универсальные принципы и компоненты, которые надо использовать вне зависимости от выбранного языка для backend: frontend/knowledge.md

🛡️ Ручная проверка безопасности

  • Запускайте make security-scan, чтобы вручную проверить проект на известные уязвимости зависимостей.
  • Команда вызывает scripts/security-scan.sh, который выполняет composer audit --locked --format=json (PHP backend) и pnpm audit --prod --json (Nuxt фронтенд) внутри соответствующих Docker-контейнеров.
  • JSON-отчёты сохраняются в reports/security/, поэтому их удобно прикладывать к задачам или отчётам в CI.
  • По умолчанию скрипт завершает работу с ошибкой при найденных уязвимостях; мягкий режим включается через SECURITY_SCAN_ALLOW_FAILURES=1 make security-scan или ./scripts/security-scan.sh --allow-fail.
  • Скрипт не запускается автоматически; разработчик сам решает, когда проверять зависимости.

🎯 Специализированные инструкции

Битрикс24 платформа

➡️ См. подробности: bitrix24/

Управление версиями стартера

➡️ Промпт: versioning/create-version-prompt.md

  • Как запустить scripts/create-version.sh, чтобы подготовить новую копию проекта (V2, V3 и т.д.)
  • Чеклист проверки, сценарии отката и рекомендации для новичков

Очереди и фоновые задачи

🔄 Рабочий процесс для AI-агентов

Шаг 1: Определение задачи

  1. Какая основная функциональность? (CRM/задачи/календарь/отчеты)
  2. Какие данные нужно обрабатывать? (лиды/сделки/контакты/компании)
  3. Какие механизмы Битрикс24 использовать (виджеты/роботы/обработчики событий)

Шаг 2: Выбор технологий

  1. Backend: выбрать между PHP/Python/Node.js на основе требований
  2. Frontend: использовать Bitrix24 UI Kit для консистентного интерфейса

Шаг 3: Чтение специализированных инструкций

  1. Прочитать [язык]/knowledge.md для общих принципов
  2. Прочитать специфические инструкции в соответствующих папках
  3. Обязательно обратиться к bitrix24/ для платформенных особенностей

Шаг 4: Реализация

  1. Следовать code-review принципам из [язык]/code-review.md
  2. Использовать типизацию и лучшие практики языка
  3. Тестировать интеграцию с Битрикс24 API

📚 Дополнительные ресурсы

Официальная документация

⚠️ Важные принципы для AI-агентов

🎯 Специализация знаний

  • НЕ загружай всю информацию сразу
  • Читай только релевантные для задачи разделы
  • Используй этот файл как навигационный центр

🔄 Итерационный подход

  • Сначала общее понимание архитектуры
  • Затем выбор технологий
  • Потом детальное изучение конкретных инструкций

📖 Актуальность информации

  • Всегда проверяй версии SDK и API
  • Обращай внимание на deprecated методы
  • Используй современные практики разработки
  • При работе с REST API используй MCP server, если он доступен

Обновлено: 25 ноября 2025 Версия: 2.0 - Модульная архитектура знаний