Weryfikacja formalna (NameCheck)

Rola standaryzacji dokumentacji

W każdym projekcie budowlanym – niezależnie od jego skali i złożoności – zarządzanie dokumentacją stanowi fundament sprawnej współpracy między uczestnikami procesu. W dobie cyfrowego obiegu informacji, gdzie strony wymieniają tysiące plików, brak standaryzacji i spójnego źródła informacji może prowadzić do kosztownych pomyłek, opóźnień czy dublowania pracy. Nie dziwi więc, że zespoły realizujące inwestycje przykładają coraz większą wagę do tworzenia jasnych zasad organizacji plików. Obejmują one nie tylko odpowiednie segmentowanie danych w folderach, ale także (a może przede wszystkim) kodyfikację plików.

Stosowanie standardu kodowania plików w pierwszej chwili może wydawać się dość trudne i nieintuicyjne. Wiele osób woli, aby dokumenty, którymi posługuje się na co dzień, miały nazwę łatwą do interpretacji, np. “Architektura – rzut parteru – zmiany”, zamiast “AR-RZ-00-01”. W praktyce jednak drugie podejście ma wiele zalet i praktycznych zastosowań.

Po pierwsze, kodowane nazwy są łatwiej interpretowalne przez systemu komputerowe. Usprawnia to wyszukiwanie informacji, np. po fragmentach nazw. W powyższym przykładzie aby znaleźć wszystkie rzuty architektoniczne wystarczy wyszukać frazę “AR-RZ” a system zwróci pełną listę, niezależnie od tego, czy pliki są w jednym czy wielu folderach. Co więcej, odpowiednia kodyfikacja pozwala minimalizować wpływ błędów ludzkich. Kod “RZ” jest prosty i czytelny, podczas gdy człowiek słowo “rzut” może zapisać na co najmniej kilka sposobów (np. “rzut”, “Rzut”, “rzuty” czy nawet “rzót”), a to utrudni lub wręcz uniemożliwi sprawne wyszukiwanie pożądanych plików. Wbrew pierwszemu wrażeniu, “zakodowane” repozytorium jest więc bardziej przejrzyste.

Utrzymanie spójnego standardu nazewnictwa znacząco ułatwia też wdrażanie kolejnych osób do projektu. Nowy członek zespołu, zamiast tracić czas na domyślanie się, gdzie znaleźć potrzebny rysunek czy dokument, gdy tylko nauczy się obowiązującego schematu, może pracować tak samo efektywnie, jak “starzy” pracownicy. Dodatkowo, gdy standard obowiązuje nie tylko na jednej inwestycji, lecz na wszystkich, użytkownicy tylko zyskują. Pracownicy przenoszący się na nowy projekt wchodzą w jego świat “jak do siebie”. Dzięki temu bez względu na typ projektu, lokalizację czy zespół, odnalezienie konkretnego dokumentu zamiast minut czy godzin (w porównaniu z tradycyjnym, papierowym repozytorium) może zajmować raptem kilka sekund.

Podsumowując: standaryzacja pozwala sprawniej poruszać się w gąszczu danych, szybciej wyszukiwać pożądane pliki i określić ich zawartość jeszcze przed otworzeniem.

Zachowanie jednolitego standardu wymaga jednak pewnej dyscypliny. Rozwiązania typu CDE zwykle dysponują narzędziami umożliwiającymi weryfikację poprawności nazewnictwa plików. Należy jednak pamiętać, że wiele plików powstaje i jest wymieniana poza CDE. W odpowiedzi na ten problem powstało narzędzie pozwalające weryfikować poprawność nazw plików względem przyjętego standardu, które znajdziecie na stronie:  https://www.bimblog.pl/narzedzia/namecheck/

Jak działa kodyfikacja?

Użytkownicy mogą kodować w nazwach plików wiele różnych informacji. Najczęściej będzie to zestaw wybrany z poniższej listy:

• Numer/nazwa projektu
• Autor dokumentu
• Etap/faza
• Branża (ogółem)
• Podbranża/zakres
• Lokalizacja
• System
• Rodzaj dokumentu
• Numer identyfikacyjny
• Tytuł/opis dokumentu
• Rewizja

Aby rozdzielić poszczególne informacje, między poszczególnymi informacjami (Polami Nazwy) występują znaki oddzielające, czyli Separatory. Najczęściej ich rolę pełni dywiz (‐; Unicode: U+2010) lub znak podkreślenia (_; Unicode: U+005F). Na końcu właściwej Nazwy Pliku znajduje się kropka, która rozdziela ją od Rozszerzenia. Cały ciąg znaków opisujących plik stanowi Pełną Nazwę Pliku, jak pokazano na poniższym rysunku.

Standard nazewnictwa – przygotowanie danych wejściowych dla Aplikacji

Aby tak skonstruowany standard mógł być prawidłowo rozpoznany przez naszą Aplikację, Użytkownik musi wyodrębnić Pola Nazwy i Separatory a w kolejnym kroku wskazać, z jakiego Rodzaju Polem algorytm będzie miał do czynienia (patrz rysunek poniżej):

• EXT – dotyczy jedynie Rozszerzenia (jeśli Użytkownik chce weryfikować ten element Pełnej Nazwy pliku)
• S – jeśli definiowany jest Separator
• P – jeśli definiowane jest zwykłe Pole Nazwy
• O – jeśli Pole Nazwy jest opcjonalne
• F – jeśli Pole Nazwy koduje kilka informacji

Pola Nazwy (P, O, F) mogą posiadać jeden z 4 typów, zależnie od tego, w jaki sposób kodują informacje.

• LIST – dla Pola Nazwy zdefiniowano skończoną listę możliwych kodów
• ANY – Użytkownik może zastosować dowolne znaki (najczęstszym przykładem Pola tego typu jest opis/tytuł dokumentu)
• TEXT – opis Pola może zawierać dowolną kombinację liter
• NUMBER – informacja w Polu Nazwy zawiera tylko liczby (najczęstszym przykładem Pola tego typu jest numer dokumentu)

Każdy z Typów Pola należy następnie sparametryzować, wskazując na minimalną i maksymalną długość Pola Nazwy (liczbę znaków, jakie opisują to Pole) lub wskazać literalnie, jakie wartości może przyjmować, poprzez jej wylistowanie.

Wskazane wyżej informacje powinny zostać uzupełnione w standardzie, który będzie wykorzystywany przez Aplikację. Sposób jego uzupełnienia opisano w instrukcji dostępnej pod linkiem: https://www.bimblog.pl/narzedzia/namecheck/

Weryfikacja poprawności przygotowania Standardu Nazewnictwa

Mając świadomość, że Aplikacja posiada pewne niestandardowe wymagania dotyczące przygotowania pliku Standardu, wprowadziliśmy narzędzie, które umożliwia sprawdzenie, czy Użytkownik uwzględnił w nim wszystkie niezbędne informacje. W przypadku braków lub niespójności Użytkownik otrzyma stosowny komunikat, który umożliwi mu szybką naprawę pliku Standardu.

Wyniki weryfikacji

Potwierdzenie poprawności przygotowania pliku Standardu umożliwia uruchomienie weryfikacji. Ma ona na celu wskazanie wszystkich plików, dla których stwierdzono nieprawidłowości, w tym:

• czy Nazwy Plików posiadają określoną w Standardzie strukturę, tj. czy mają odpowiednią liczbę Pól Nazwy
• czy Pola Nazwy zostały zdefiniowane zgodnie z wytycznymi zawartymi w Standardzie
• czy na liście weryfikowanych plików nie ma plików o zerowym rozmiarze
• czy wskazane pliki spełniają wymagania dot. formatów wymiany danych (jeśli zdefiniowano wymagania dot. rozszerzeń plików)

Powyższe informacje zostały przedstawione na 2 sposoby, zależnie od celu przeprowadzenia weryfikacji. RAPORT przeznaczony jest na cele sprawozdawcze i zawiera krótkie podsumowanie uzyskanych wyników, także w sposób graficzny. WYNIKI SZCZEGÓŁOWE pokazują, w jaki sposób Aplikacja dokonała podziału Nazwy Pliku na Pola oraz jak jest wynik weryfikacji każdego z nich. Tabela wyników daje się sprawnie sortować i filtrować błędy, co usprawnia Użytkownikowi proces ich eliminacji.

Podsumowanie

Standaryzacja nazewnictwa plików to nie tylko zachowanie porządku w używanych repozytoriach. To narzędzie do zwiększenia efektywności pracy i minimalizacji ryzyka błędów. Nasza Aplikacja, choć ma kilka wad:

• wymaga przygotowania standardu nazewnictwa w ściśle określony sposób
• nieodpowiedni dla firm korzystających z innych pakietów biurowych niż MS Office (planujemy  wersję stand-alone, niewymagającej dodatkowych narzędzi)

posiada także masę zalet, których nie można pominąć:

• aplikacja umożliwia weryfikację plików jeszcze w obszarze Work In Progress
• może być stosowana niezależnie od funkcjonalności CDE
• pozwala zdefiniować więcej zasad dla nazewnictwa niż większość CDE
• umożliwia weryfikację także w zakresie formatów wymiany danych
• zwraca szczegółowe wyniki, dzięki czemu naprawa ewentualnych błędów może odbyć się błyskawicznie
• wymaga jedynie MS Excel
• może służyć do raportowania

Jeśli powyższa lista to za mało lub jesteście ciekawi, jak Aplikacja działa w praktyce, zachęcamy do testowania! Aplikację oraz instrukcję z przykładami znajdziecie TUTAJ.