Dokumentacja techniczna Leszek Kaczmarek, Łukasz Gmaj, Maciej Stępniak

Plan prezentacji Dokumentacja techniczna oprogramowania Dokumentacja obsługi programu Zawartość dokumentacji technicznej urządzeń Opis działania układu Schemat ideowy Wykaz podzespołów elektrycznych Dokumentacja mechaniczna

Dokumentacja oprogramowania Dokumentacja techniczna programu: Opis celu, zakresu i kontekst systemu Specyfikacja wymagań funkcjonalnych i niefunkcjonalnych (czas reakcji) Konfiguracja systemu oraz wymagania sprzętowe Zastosowany język oprogramowania (wersja), architektura Opis procedur, algorytm działania Kod źródłowy z komentarzami

Dokumentacja oprogramowania Omówienie danych wejściowych/wyjściowych Opis struktury bazy danych Diagram systemu kolejkowego Kolejność wykonywania działań – diagramy przejść stanów (UML) Omówienie komunikatów oraz interakcji z użytkownikiem Proces testowania programu (raport testów oraz oszacowanie niezawodności oprogramowania) Ustawienia kompilatora Wspomaganie się zrzutami ekranu

Dokumentacja techniczna układów lub urządzeń Prawidłowo sporządzona dokumentacja techniczna, stanowi doskonałe źródło informacji w przypadku naprawy bądź modyfikacji gotowego wyrobu.

Zawartość dokumentacji technicznej urządzeń lub układów Podstawowe parametry techniczne układu, Opis działania układu lub urządzenia, Schematy blokowe, ideowe, widoki płytek PCB, prezentujące rozmieszczenie elementów, Lista użytych elementów i podzespołów, Opis czynności niezbędnych do uruchomienia, konserwacji czy kalibracji, Rysunki techniczne elementów mechanicznych, Nośnik danych z plikami zawierającymi projekty płytek PCB.

Opis działania układu Schemat blokowy – dobry sposób przedstawienia zasady działania urządzenia, bądź układu. Powinien być uzupełniony wyczerpującym opisem funkcji spełnianej przez moduły urządzenia oraz analizą działania poszczególnych podukładów.

Opis działania układu Dodatkowo zaleca się umieszczenie informacji o wartościach parametrów charakteryzujących układ, w tym wartości napięć i prądów czy oscylogramów z charakterystycznych punktów układu. Obowiązkową czynnością, jest umieszczenie sposobów uruchamiania, kalibracji oraz strojenia urządzenia lub układu. W tej części powinno zostać również opisane wykonanie wszystkich niestandardowych elementów układu, w tym transformatorów, dławików, cewek (podanie dobroci czy przekładni).

Schemat ideowy urządzenia lub układu R – Rezystor P - Potencjometr C – Kondensator L – Indukcyjność Dł – Dławik Tr – Transformator S – Włącznik/Przełącznik T – Tranzystor Th – Tyrystor D – Dioda U – Układ scalony

Schemat ideowy urządzenia lub układu Czytelny i przejrzysty Naniesione oznaczenia elementów Podanie typów oraz wartości elementów Poszczególne moduły otoczone obwódką (linia przerywana) Wyprowadzenia płytek oznaczone kółkiem i ponumerowane Podanie wartości napięć DC na elektrodach elementów p-przewodnikowych i na zaciskach zasilania (i innych ważnych punktach) oraz poborów prądu

Wykaz podzespołów elektrycznych Lista elementów zawierająca symbole, wartości, numerację, typy, nazwy producentów. Przykładowa tabela podzespołów: Oznaczenie Dane techniczne Uwagi R10 Rezystor - 0,25W – 300Ω, 5% Brak U10 Układ scalony – TMS320F2809PQZ

Rysunek płytek drukowanych Rysunek rozmieszczenia elementów na płytce drukowanej w skali 1:1 od strony druku z pokazaniem mozaiki ścieżek. W przypadku płytek dwustronnych należy zamieścić obie strony z rozmieszczeniem elementów na osobnych rysunkach. PCB dwuwarstwowa musi się składać z obrazu co najmniej czterech warstw płytki (Top Layer, BottomLayer, Top Solder, Bottom Solder) Każda z warstw musi zostać przygotowana jako pozytyw Właściwy opis płytek oraz jej stron.

Rysunek płytek drukowanych Dla skomplikowanych płytek można nie zamieszczać mozaiki ścieżek lub poprawić czytelność przez zmianę koloru ścieżek z czarnego na jasny szary Do dokumentacji należy dołączyć pliki potrzebne do wykonania płytek drukowanych (pliki Gerbera i/lub wiertarki numerycznej dla otworów). Dodatkowo należy dołączyć informację jakim programem (również jaką wersją programu) był projekt wykonany.

Dokumentacja mechaniczna Jeśli dokumentacja mechaniczna została wykonana to należy dołączyć ją również do dokumentacji. Składają się na nią rysunki wykonawcze: obudów, płyty czołowe, wsporniki, itp. Dokumentacja mechaniczna nie jest konieczna w pracy dyplomowej.

Dziękujemy!