База знаний: как создавать

База знаний
Версия: v2Дата: 15.06.2026

Где создать страницу

Откройте /projects/{projectUuid}/knowledge и нажмите Создать страницу. Можно также открыть панель документации рядом с конкретной сущностью через EntityKnowledgePanel и создать страницу оттуда.

База знаний: кнопка создания
Создание доступно из списка базы знаний и из панели связанной сущности.

Какие поля заполнить

  1. Заголовок — понятное название, например «Документация: новогодняя короткая ссылка».
  2. Тип страницы — ARTICLE, RUNBOOK, SCENARIO_DOC или ENTITY_DOC.
  3. Комментарий к версии — что изменилось в этой версии.
  4. Видимость — PROJECT или COMPANY.
  5. Текст документации — заполняется через EditorJS; картинки загружаются через cdp_files.
База знаний: EditorJS форма
EditorJS сохраняет JSON, HTML и plain text, чтобы страницу можно было показывать и искать.

Как писать полезную страницу

  • Начинайте с ответа «зачем существует объект».
  • Добавляйте владельца и дату последней проверки.
  • Фиксируйте опасные действия: что нельзя менять без согласования.
  • Добавляйте ссылки на связанные отчёты, события, сценарии и внешние документы.

Технически: пользователь работает во frontend через REST в gateway. Внутри CDP используется контур gateway → cdp_knowledge; картинки и вложения проходят через cdp_files, связи хранятся как anchors на сущности CDP. Пользователю это нужно знать только для диагностики: если UI показывает ошибку, смотрите route, HTTP-статус gateway и связанный сервис.

База знаний: готовая страница
После сохранения откройте страницу и проверьте renderedHtml, plainText и связанные объекты.