Главная / Документация / Правила и знания
Правила (конвенции) и записи знаний — то, что агент получает о проекте. Правило доставляется агенту, когда он работает с привязанным к правилу кодом; на ревью изменения проверяются по тем же правилам.
Экран Conventions → + Create.
| Поле | Что указать |
|---|---|
| Name | Короткое название правила |
| Description | Текст правила. Агент получает его целиком, поэтому формулировка должна быть применима без пояснений |
| Severity | must — обязательное, should — рекомендуемое, note — заметка |
| Category | Область правила: code, architecture и другие |
| Scope | Entity — конкретные сущности, Project — весь проект, Path — место в дереве файлов |
| Audience | Кому адресовано. Правило для ревью проверяется при ревью и не доставляется агенту, который пишет код |
| Binding conditions | Условия привязки в JSON, например совпадение по пути |
Если у правила ноль привязок, агент его не получит. Проверьте число привязок на карточке. После переименования или переноса кода нажмите Rebind.
Экран Knowledge: решения (decision), заметки (note), журналы изменений (changelog), схемы (diagram) и процедуры (procedure). Записи создают люди и агенты. Запись доставляется агенту, когда он работает со связанным кодом; если на карточке ноль связанных сущностей, запись не доставляется — укажите файлы и модули, к которым она относится.
Записи живут на ветках git: выбор ветки в заголовке показывает записи этой ветки, число записей других веток указано отдельно.
Экран Knowledge review. Проверка не меняет и не скрывает запись, а ставит метку: «устарела с коммита…», «заменена другой записью» или «оспорена». Читатель получает запись вместе с меткой.
Модель проверки, лимит в день и второе мнение настраиваются в Settings → Knowledge review.