Ім'я, синонім, коментар

Див. також

1.1. Синонім об'єкта має бути визначений так, щоб змістовно, лаконічно описувати об'єкт. Заповнюється обов'язково.

Ця вимога зумовлена тим, що синоніми безпосередньо беруть участь у формуванні інтерфейсу користувача (відображаються у формах, звітах, командному інтерфейсі тощо) і тому мають коректно й однаково в усіх місцях інтерфейсу користувача ідентифікувати ту сутність, якої вони стосуються. Крім об'єктів метаданих, вимога поширюється також на реквізити об'єктів метаданих, табличні частини, реквізити табличних частин, виміри регістрів, ресурси та інші об'єкти конфігурації, які мають синонім.

1.2. Не рекомендується використовувати в синонімах об'єктів скорочення. Винятком є лише загальновживані та відповідні цільовій аудиторії скорочення (наприклад, Сума (регл.) ) і абревіатури (наприклад, ПДВ або МСФЗ).

1.3. У синонімах об'єктів і текстових повідомленнях користувачу мають використовуватися загальноприйняті терміни, зрозумілі користувачу. Не повинно бути сленгу, спотворення назв продуктів і компаній; англомовних фраз, записаних російськими літерами; російськомовних англійськими літерами тощо.

Зокрема, якщо для англомовного терміна немає загальноприйнятого перекладу російською мовою, слід використовувати оригінальний англомовний термін.
Наприклад, неправильно: «Завантаження даних з Ексель»;
правильні варіанти: «Завантаження даних з Microsoft Excel», «Завантаження даних із програми MS Excel».

1.4. Якщо об'єкт метаданих має стандартні реквізити, для них також слід указувати синоніми, виходячи з прикладного змісту кожного реквізиту.

1.5. При цьому для стандартних реквізитів Батько і Власник слід завжди вказувати синоніми, відмінні від синонімів за замовчуванням. Наприклад, у конфігурації є довідник Файли зі стандартним реквізитом Власник типу ДовідникПосилання.ПапкиФайлів. У цьому випадку
неправильно

• залишати синонім стандартного реквізиту Власник за замовчуванням: «Власник»;

правильно

• вкласти в синонім прикладний зміст: «Папка» або «Папка з файлом».

Інший приклад. Тоді як для стандартного реквізиту Найменування деяких довідників цілком може підійти синонім за замовчуванням «Найменування», у випадку з довідником Файли доцільніше призначити синонім «Ім'я файлу», а для довідника ФізичніОсоби – дати синонім «ПІБ».

Див. також: Представлення об'єктів користувача, Тексти

1.6. У випадку, коли є два (або більше) об'єкти метаданих зі схожим призначенням, необхідно, щоб синоніми кожного об'єкта повністю описували кожен об'єкт.

Наприклад, неправильно давати довідникам такі синоніми:

• Банківські рахунки,
• Банківські рахунки контрагентів

правильно:

• Банківські рахунки організацій,
• і Банківські рахунки контрагентів

Слід називати ці об'єкти явно, щоб у користувача не виникало запитання: «Якщо в довіднику Банківські рахунки контрагентів зберігається інформація про рахунки контрагентів, то інформація про чиї рахунки зберігається в довіднику Банківські рахунки?»

Ця вимога справедлива і для синонімів підпорядкованих об'єктів метаданих (реквізитів, табличних частин, вимірів, ресурсів тощо).
Приклад із реквізитами табличної частини «Товари» документа «Перерахунок товарів».
Неправильно:

• Кількість
• Кількість (за обліком)

правильно:

• Кількість (у наявності)
• Кількість (за обліком)

Приклад зі стандартним реквізитом Найменування і ще одним реквізитом довідника «Номенклатура».
Неправильно:

• Найменування
• Повне найменування

правильно:

• Робоче найменування
• Найменування для друку

2.1. Ім'я об'єкта рекомендується будувати на основі синоніма: пробіли та інші неприпустимі в імені символи видаляються, а перші літери слів робляться великими. Наприклад, правильно, коли:

• у довідника НабориДодатковихРеквізитівТаВідомостей задано синонім «Набори додаткових реквізитів та відомостей»
• у загальної команди ПриєднаніФайли – синонім «Приєднані файли».

Також допустимі ситуації, коли ім'я коротше описує об'єкт, ніж синонім – коли в імені «скорочено» одне або кілька останніх «малозначущих» слів із синоніма. Наприклад:

• ТривалістьОчікуванняСервера – синонім «Тривалість очікування сервера (сек)»
• КількістьОдиниць – синонім «Кількість одиниць вимірювання»
• Обробки.ГруповаЗмінаОб'єктів.Операції.Ім'яРеквізиту – синонім «Ім'я реквізиту (властивість)»

Ім'я також може не включати сполучники та прийменники з тексту синоніма, наприклад: для реквізиту ЗначенняЗнижкиНацінки синонім «Значення знижки або націнки».

А також навпаки, допустимі ситуації, коли синонім коротше описує об'єкт, ніж ім'я – коли в синонімі «скорочено» одне або кілька останніх «технічних» слів з імені.

Ця вимога зумовлена тим міркуванням, що об'єкти конфігурації та їхні представлення в інтерфейсі користувача мають бути максимально легко впізнаваними, наприклад, під час упровадження, яке проводиться не самими розробниками конфігурації, а силами технічних спеціалістів з упровадження.

Див. також: Додаткові вимоги до імен об'єктів метаданих у конфігураціях

2.2. Імена об'єктів метаданих верхнього рівня (довідники, документи тощо) не повинні перевищувати 128 символів.

2.3. Для підпорядкованих об'єктів метаданих, таких як реквізити, виміри, ресурси, рекомендується не використовувати імена, що збігаються з іменами об'єктів-власників. Наприклад, вимір Користувач (типу ДовідникПосилання.Користувачі) регістру відомостей ВиконавціЗавдань названо некоректно; правильна назва виміру, що розкриває його зміст: Виконавець.

2.4. Також рекомендується не використовувати імена, які застосовуються під час найменування таблиць мови запитів (наприклад, Документ, Довідник, РегістрВідомостей тощо). Такі імена можуть призводити до помилок під час виконання запиту, ускладнюють використання конструктора запиту та знижують наочність тексту запиту. Наприклад, виконання цього запиту викликає помилку:

ВИБРАТИ 
Відомості.Відомості 
З 
РегістрВідомостей.Відомості ЯК Відомості

2.5. Винятком із цього правила є об'єкти метаданих із префіксом Видалити.

3.1. Коментар задається лише в тих випадках, коли необхідно дати учаснику розробки конфігурації якісь пояснення щодо цього об'єкта конфігурації. Наприклад, коментар до реквізиту довідника може бути таким: "Індексування встановлено для оптимізації звітів із відбором за видом контрагента", або: "Використовується в регламентованому обліку".

3.2. Коментар починається з великої літери, крапки ставляться лише після скорочень.

4. В іменах, синонімах і коментарях не допускається використовувати літеру "ё".

Див. також

• Представлення об'єктів користувача
• Підказка та перевірка заповнення
• Реквізит "Коментар" у документів