Руководство по созданию полей
Правила для сопровождающих, документирующих новые поля интерфейса Entry UI.
Когда вы добавляете поле
-
Добавьте поле в
CONFIG_FIELDSвsrc/core/web/config-schema.tsс кратким описанием (description), параметрами (options), значениямиmin/max/stepи риском (risk). -
Добавьте запись документации в
website/src/data/entryFields.tsкак минимум сshortDescription,useCasesиguidelines. -
Задокументируйте поле на странице Вкладка Construct и в Полном справочнике полей.
-
Запустите проверку охвата документации полей:
npm --prefix website run check:entry-fields -
Если поле рискованное, добавьте как минимум одно примечание по восстановлению/устранению неполадок.
Обязательные элементы документации для каждого поля
| Элемент | Обязательно |
|---|---|
| Простая формулировка описания | Да |
| Варианты использования | Да (1+) |
| Рекомендуемое значение по умолчанию | Да |
| Допустимые значения / диапазон | Да |
| Уровень риска | Да |
| Побочные эффекты | При необходимости |
| Эквивалент в CLI | При необходимости |
| Примеры значений | Для текстовых полей и путей |
| Примечания по устранению неполадок | Для рискованных полей |
Правила написания
- Пишите для пользователя, настраивающего систему памяти ИИ-агента, а не для разработчика, читающего исходный код.
- Указывайте реальное влияние на право собственности на память, маршрутизацию, размер контекста, конфиденциальность или синхронизацию Git.
- Отдавайте предпочтение примерам из рабочих процессов Engram: Codex, Claude, Gemini, Cursor, OpenCode, личная память, профиль клиента, репозиторий команды.
- Не рекомендуйте высокие лимиты по умолчанию; объясняйте компромиссы раздувания контекста.
- Помечайте настройки как рискованные, если они могут отключить Engram, изменить место сохранения, изменить синхронизацию Git, архивировать память или повлиять на шифрование/безопасность.
- Включайте команды восстановления для рискованных настроек.
- Держите описания в приложении краткими; подробное руководство размещайте в Docusaurus.
Охват CI
Скрипт website/scripts/check-entry-field-docs.mjs завершается с ошибкой, если:
- Для видимого ключа
CONFIG_FIELDSотсутствует запись в документации. - Запись документации ссылается на поле, которого больше нет в
CONFIG_FIELDS. - Для поля отсутствует
shortDescription,useCasesилиguidelines. - Для рискованного поля отсутствует как минимум одно примечание по устранению неполадок.
- Для числового поля упущен допустимый диапазон в отрендеренных документах.