DOKUMETACJA. ISTOTNY ELEMENT KAŻDEGO PROJEKTU

Często niedocenianą,  lecz niesłychanie istotną rzeczą  podczas pracy z projektem jest dokumentacja. Zafascynowanie samym aktem tworzenia może w wielu przypadkach przysłonić skupianie uwagi na szczegółach oraz jakości wykonywanej pracy. A  jak powszechnie wiadomo „diabeł tkwi właśnie w szczegółach”.
 
Warto przy tym pamiętać stare porzekadło, mówiące że sukces jest złożony z małych, z pozoru nic nie znaczących  elementów.
 
Dobrze opracowana dokumentacja, przejrzysty schemat, przede wszystkim bardzo ułatwia ewentualne modyfikacje oraz przyszłe prace serwisowe. W przypadku gdy nasz projekt trafił by na produkcje, przejrzysta dokumentacja jest wręcz niezbędna, ponieważ  może się zdarzyć (i w praktyce  się zdarza) ze projekt zostanie poddany modyfikacją przez inne osoby, wówczas bez odpowiednio przejrzystej dokumentacji trudno jest ustalić jakim zamysłem  kierował się pierwotny projektant układu.
 
W zależności od komplikacji projektu, zespołu realizacji, czy tez przeznaczenia docelowego gotowego wyrobu, dokumentacja  może być mniej lub bardziej rozbudowana.  
 
Jednym  z podstawowych elementów dokumentacji jest lista materiałowa, potocznie określana skrótem BOM -Bild Of Material. W BOM winien zawierać informacje o oznaczeniu elementów, liczbie elementów, ich typie, ewentualnych zamiennikach, rodzaju obudowy, technologii wykonania, mogą również znaleźć się tam wskazówki dla działu zaopatrzenia wraz z uwagami.
 
Przykładowa lista materiałowa (BOM)


 
Lista materiałowa niezgodna z dobrymi praktykami
 

Listę materiałową można sporządzić w pliku tekstowym (np. MS WORD) bądź tez w  arkuszu kalkulacyjnym. 
 
Ważną częścią każdej dokumentacji jest opis funkcjonalny układu oraz poszczególnych jego bloków. Można to zrealizować za pomocą edytora graficznego,  tekstowego, lub w samym oprogramowaniu CAD. Również wiele z pakietów CAD, chociażby Altium, posiada wbudowaną funkcje tworzenia dokumentacji technicznej.  Warto wiedzieć że istnieją pakiety oprogramowania stworzone specjalnie na potrzeby realizacji dokumentacji technicznej. 
 
        Pełna dokumentacja techniczna  umieszczona w jednym złożonym pliku projektu  pakietu Altium.
 

To czy skorzystamy z wbudowanej, dodatkowej funkcjonalności  czy tez posłużymy się odrębnymi narzędziami zależy nie tylko od naszych upodobań ale również od skali projektu nad którym pracujemy. Inaczej będzie wyglądała praca indywidualna, bądź tez w małym zespole, inaczej zaś gdy będziemy opracowywali awionike samolotu pasażerskiego. 
 
 
Przykładowy opis bloków układu

Bardzo istotną sprawą są również notatki z przeprowadzonych testów  laboratoryjnych. Notatki te winny uwzględniać warunki przeprowadzanych testów.  Notatki konstrukcyjne dotyczące fizycznej wykonalności projektu także należą do dobrych praktyk.
 
Opis złącz modułu zaczerpnięty z autentycznej dokumentacji  
 
Opis złącza 
 
Opis złącza niezgodny dobrymi praktykami 
 
@Copyright  Mariusz Witurski 2019 -2023