steelmorgan/metadata-object-design

Проектирование объектов метаданных 1С

Этот навык дополняет XML-спецификации и БСП-справочники. XML-спеки говорят, как устроен файл; этот чек-лист говорит, какие прикладные инварианты нужно не забыть при создании или ревью объекта в рабочей конфигурации.

Перед созданием объекта проверь исходные метаданные через LSP/get_metadata_structure или текущую выгрузку. Если объект относится к типовой конфигурации, не меняй типовой объект без явного решения: новую логику изолируй в своих модулях, подсистемах и расширениях.

Общие правила

• [ ] Имя, синоним и представления соответствуют стандартам 1С и проектному префиксу.
• [ ] Новый объект добавлен в служебную подсистему; пользовательское размещение задано только если оно есть в ТЗ/ТР.
• [ ] Для нового объекта определены роли доступа и роль подсистемы, если объект выводится в интерфейс.
• [ ] Если объект участвует в RLS или имеет реквизит/измерение Организация, добавлены hooks управления доступом.
• [ ] Если объект должен попадать под дату запрета изменения, подключены механизмы БСП ДатыЗапретаИзменения.
• [ ] Для новых объектов в типовых конфигурациях указан комментарий с причиной добавления, если это требуется проектным стандартом.

Справочники

• [ ] ПредставлениеОбъекта задано в единственном числе; ПредставлениеСписка - во множественном, если отличается от синонима.
• [ ] Если длина Наименование не задана явно, используй проектный default 150.
• [ ] Если Код не имеет прикладного смысла, установи длину кода 0; если имеет - длина и формат должны следовать бизнес-смыслу.
• [ ] Для обязательных реквизитов включена Проверка заполнения; не заменяй ее ручной проверкой без причины.
• [ ] Связи параметров выбора и Параметры выбора заполнены, если значение реквизита зависит от других реквизитов или ограничивается отбором.
• [ ] Префиксация включена только когда справочник участвует в распределенных/интеграционных сценариях или это явно задано проектом.
• [ ] Если включается версионирование или подключаемые команды БСП, использованы штатные hooks БСП, а не собственная инфраструктура.

Документы

• [ ] Имя документа в единственном числе; синоним обязателен.
• [ ] ПредставлениеОбъекта задано в единственном числе, ПредставлениеСписка - во множественном, если отличается от синонима.
• [ ] Текст в командном интерфейсе короткий: желательно до 30 символов, максимум около 38.
• [ ] ОперативноеПроведение по умолчанию запрещено, если нет отдельного требования.
• [ ] Если конфигурация использует учетный механизм проведения, новый документ следует этому механизму. Даже документ без движений получает каркас проведения, если так принято в проекте.
• [ ] Удаление движений и повторное проведение реализованы через принятый механизм конфигурации, без ручной очистки регистров в случайных местах.
• [ ] Для документа подключены дата запрета, роли, подсистемы и RLS hooks, если применимо.

Регистры

• [ ] У обязательных измерений включен Запрет незаполненных значений; не включай его для измерений, где пустое значение допустимо по модели.
• [ ] Порядок измерений отражает частоту использования в отборах и соединениях: наиболее селективные/частые измерения идут раньше.
• [ ] Регистры, подчиненные документу, обычно получают только роль чтения, если запись идет через регистратор.
• [ ] Для регистров с Организация или другим ключом доступа добавлены RLS hooks: список ограничиваемых объектов, ПриЗаполненииОграниченияДоступа, определяемые типы владельцев ключей доступа.
• [ ] Для набора записей подключена проверка даты запрета, если регистр участвует в закрываемых периодах.

Отчеты

• [ ] Отчет подключен к БСП ВариантыОтчетов, если в конфигурации используется эта подсистема.
• [ ] У отчета заполнено Хранилище вариантов.
• [ ] Стандартные команды отчета отключены, если отчет открывается через ВариантыОтчетов.
• [ ] Не оставляй вариант отчета с именем Основной; имя варианта должно быть прикладным.
• [ ] После подключения отчета учтен обработчик обновления/версия ИБ, чтобы отчет появился у пользователей после обновления.
• [ ] Создана роль ПросмотрОтчета<ИмяОтчета>.
• [ ] В запросах отчета учтен RLS (РАЗРЕШЕННЫЕ и проектные ограничения доступа).
• [ ] Не используй внешний отчет/обработку как способ обойти релизный цикл, если отчет должен быть частью поставки.

Роли

• [ ] Для новых объектов созданы отдельные роли доступа; для подсистем верхнего уровня - роль Подсистема<ИмяПодсистемы>.
• [ ] У роли ПолныеПрава для новых объектов снято ИнтерактивноеУдаление, если проектный стандарт запрещает интерактивное удаление.
• [ ] У прикладных ролей отключены права подключения клиентов, если роль не предназначена для входа в приложение.
• [ ] Имена ролей следуют шаблонам: Чтение<ИмяФункции>, ДобавлениеИзменение<ИмяФункции>, ПросмотрОтчета<ИмяОтчета>, ИспользованиеОбработки<ИмяОбработки>, Подсистема<ИмяПодсистемы>.
• [ ] Не используй команды редактора роли "установить все" / "снять все" как способ настройки новой роли.
• [ ] В коде предпочитай пакетную проверку ролей (Пользователи.РолиДоступны(...)) точечным проверкам, если такая инфраструктура доступна.

Подсистемы

• [ ] Все новые объекты размещены в служебной подсистеме.
• [ ] Пользовательские подсистемы создаются на втором уровне; типовые подсистемы не меняются без явного решения.
• [ ] Если доработка добавляет несколько связанных объектов, выдели функциональную подсистему внутри служебной подсистемы.
• [ ] Для пользовательской подсистемы создана роль просмотра подсистемы; доступность родительской подсистемы не означает доступность дочерней.
• [ ] Порядок объектов в пользовательской подсистеме помогает работе пользователя: справочники выше документов, важное выделено штатными средствами.

Регламентные задания

• [ ] Метод регламентного задания - тонкий entrypoint; основная логика находится в профильном общем модуле или модуле менеджера.
• [ ] В начале выполнения вызывается ОбщегоНазначения.ПриНачалеВыполненияРегламентногоЗадания(Метаданные.РегламентныеЗадания.<ИмяЗадания>), если доступна БСП.
• [ ] Флаг Использование по умолчанию выключен, если задача не должна стартовать сразу после поставки.
• [ ] Задание добавлено в служебную подсистему и имеет понятное расписание/описание для администратора.

Связанные навыки

• ssl-patterns - точные модули и hooks БСП.
• form-patterns и form-visual-requirements - формы и UX.
• query-patterns и query-optimize - запросы объектов и отчетов.
• api-design - экспортные методы модулей объекта/менеджера/общих модулей.

---

depends_on:

• ssl-patterns
• form-patterns
• query-patterns
• api-design

---