File Naming Convention, FNC
«Імена файлів» — це імена, які перераховані в каталозі файлів і присвоєні новим файлам при їх першому збереженні. Угода про іменування файлів (File Naming Convention, FNC) — це система іменування файлів у спосіб, який описує, що вони містять і як вони пов’язані з іншими файлами. File Naming Convention, FNC, включає: принципи для імен файлів, логічну структуру каталогів, правила іменування та шаблони іменування файлів.- Машиночитаність
- Людиночитаність
- Системно сортуються
Перевірте, чи встановлені правила іменування файлів у вашій дисципліні чи групі. Правила іменування мають бути задокументовані, щоб інші працівники вашої лабораторії чи відділу могли дотримуватися цього стандарту.
Імена файлів мають бути описовими та надавати достатньо контекстної інформації.
Використовуйте заголовні букви для розділення слів, а не пробіли або символи підкреслення
Намагайтеся не робити імена файлів занадто довгими. Операційні системи мають різні обмеження на кількість символів. Як правило, намагайтеся мати ліміт 40-50 символів.
Розмістіть найважливішу інформацію спочатку. Комп’ютер упорядковує файли за назвою, символ за символом. При включенні особистого імені в ім'я файлу спочатку вкажіть прізвище, а потім ініціали.
Якщо ви плануєте знайти файл за датою, спочатку вставте дату. Для дати використовуйте стандарт ISO 8601 (YYYYMMDD). Щоб додати мітку часу до імені файлу, використовуйте формат YYYYMMDDThhmm. Використовуйте 24-годинний час, щоб уникнути будь-якої плутанини щодо ранку/полудня.
Номер версії запису повинен бути вказаний в імені файлу шляхом включення «V», номеру версії і, де це доречно, «Чернетка». Під час використання системи послідовної нумерації, використовуйте початкові нулі, щоб переконатися, що файли сортуються в послідовному порядку, наприклад: 001, 002, ...010, 011 ... 100, 101 ... Позначте фінальну версію.
Використовуйте керування версіями, щоб вказати найновішу версію файлу. Приклад: filename_v2.xxx
Уникайте спеціальних символів, таких як: ~ ! @ # $ % ^ & * ( ) ` ; : < > ? . , [ ] { } ' " |
Не використовуйте пробіли, оскільки деяке програмне забезпечення не розпізнає назви файлів із пробілами. Інші варіанти включають підкреслення, тире, без розділення або регістр (перша літера кожної частини тексту велика).
Приклади шаблонів іменування:
20220104_ProjectA_Ex1Test1_SmithE_v01.xlsx
20220104_ProjectA_MeetingNotes_SmithE_v02.docx
Checklist-File-Names-Form чеклист від Гарварда (див. Контрольний список угоди про імена файлів)
Чек-ліст: Для розробки власних шаблонів іменування
Caltech (Каліфорнійський технологічний інститут)
1. Яку групу файлів охоплюватиме угода про іменування?
Ви можете використовувати різні угоди для різних наборів файлів.
Приклад: Ця угода застосовуватиметься до всіх файлів мікроскопії, від необробленого зображення до обробленого зображення.
2. Яка інформація (метадані) є важливою щодо цих файлів і робить кожен файл відмінним?
В ідеалі виберіть три частини метаданих; використовувати не більше п'яти. Цих метаданих має бути достатньо для візуального сканування імен файлів і легкого розуміння, що в кожному з них.
Приклад: Для зображень дослідження NN треба знати дату, ідентифікатор зразка та номер зображення для цього зразка на цю дату.
1:
2:
3:
4?
5?
3. Чи потрібно скорочувати будь-які метадані чи кодувати їх?
Якщо будь-які метадані з кроку 2 описані великою кількістю тексту, вирішіть, яку скорочену інформацію зберегти. Якщо будь-який із метаданих з кроку 2 мають стандартні категорії, стандартизуйте категорії та/або замініть їх 2- або 3-літерними кодами; обов’язково задокументуйте ці коди.
Приклад: Ідентифікатор зразка використовуватиме код, що складається з: 2-літерної абревіатури проекту (project 1 = P1, project 2 = P2); 3-букв абревіатура виду (mouse = “MUS”, fruit fly = “DRS”); і 3-значний ідентифікатор зразка (присвоєний у дослідницькому блокноті).
4. Який порядок метаданих в імені файлу?
Подумайте, як ви хочете сортувати та шукати файли, щоб вирішити, які метадані мають відображатися на початку імені файлу. Якщо дата важлива, використовуйте дати у форматі ISO 8601 (РРРРММДД або РРРР-ММ-ДД) на початку імені файлів, щоб дати сортувалися в хронологічному порядку.
Приклад: Мій ідентифікатор зразка є найважливішим, тому я введу його спочатку, потім дату, а потім номер зображення.
1:
2:
3:
4?
5?
5. Які символи ви будете використовувати для розділення кожної частини метаданих в назві файлу?
Багато комп’ютерних систем не можуть обробляти пробіли в іменах файлів. Щоб зробити імена файлів доступними для читання комп’ютером і людиною,
використовуйте тире (-), підкреслення (_) та/або велику першу літеру кожного слова в іменах файлів.
Приклад: Я буду використовувати підкреслення для розділення метаданих і тире між частинами свого ідентифікатора зразка.
6. Чи потрібно буде відстежувати різні версії кожного файлу?
Ви можете відстежувати версії файлу, додаючи інформацію про версію в кінці імені файлу. Розгляньте можливість використання версії номеру (наприклад, «v01») або дату версії (використовуйте формат ISO 8601: РРРРММДД або РРРР-ММ-ДД).
Приклад: Коли кожне зображення проходитиме мій робочий процес аналізу, я додаватиму тип версії в кінці назви файлу (наприклад, «_raw» необроблені, «_processed» оброблені тощо)
7. Запишіть свій шаблон іменування.
Переконайтеся, що в угоді використовуються лише буквено-цифрові символи, тире та підкреслення. В ідеалі імена файлів мають 25-32 символа.
Приклад:
Мої шаблони іменування файлів: «SA-MPL-EID_YYYYMMDD_###_status.tif»,
«P1-MUS023_20200229_051_raw.tif»,
«P2-DRS-285_20191031_062_composite.tif».
8. Задокументуйте цю угоду у файлі README.txt (або збережіть цей робочий аркуш) і зберігайте його разом із файлами.
Рішення про FNC у групі корисно для ефективного спілкування та послідовності у вашій роботі. Якщо ви надаєте дані та співпрацюєте з іншими в загальних папках або просторах, ще важливіше, щоб усі члени команди дотримувалися одних і тих самих угод та стандартів. Це, до речі, стосується не тільки організації роботи науковців, але взагалі командних проєктів.
- Запропонуйте спільну папку з ієрархією папок та файлом readme в документації для нових учасників.
- Переконайтеся, що всі члени команди або співробітники мають доступ до керівництва та навчаються правил.
- Перевірте встановлені правила іменування файлів для вашої галузі. Багато дисциплін мають рекомендації, наприклад: програма вимірювання атмосферного випромінювання (ARM) Міністерства енергетики США.
- Крім текстових файлів, ви також можете розглянути можливість проведення короткого внутрішнього навчання, щоб пояснити, чому нову угоду про іменування файлів так важливо використовувати і як вона працює, або створити відео, в якому розглядаються ключові моменти угод
Немає коментарів:
Дописати коментар