Dokument projektowy musi zawierać wszystkie aspekty projektowania systemu. Obejmuje to specyfikację, zamierzenia projektowe, proces projektowania oraz śledzenie z powrotem do specyfikacji. Tylko wtedy projektant może być pewien, że wszystkie istotne informacje o projekcie zostały zebrane w jednym miejscu. Ten dokument ma być wytyczną, która skłoni Cię do rozważenia, jak uchwycić szczegóły projektu wykraczające poza rysunki wykonawcze i montażowe.
Jednym z najważniejszych, a często pomijanych aspektów dokumentowania projektu jest formalny dokument projektowy. Zbyt często kończymy projekt, generujemy dokumenty wykonawcze, montażowe i walidacyjne, a następnie uważamy zadanie za zakończone. Prawidłowe uchwycenie specyfikacji systemu, zamierzeń projektowych, procesu projektowania oraz śledzenie z powrotem do specyfikacji to czasochłonne i żmudne, lecz bardzo potrzebne zadanie.
Uchwycenie szczegółów projektu w dokumentacji edytora PCB musi rozpocząć się na etapie planowania każdego projektu i zaczyna się od specyfikacji. Jeśli projektowany dokument dotyczy podsystemu większego systemu, należy przedstawić specyfikację całego systemu, a następnie adresować te części specyfikacji systemu, które przekładają się na podsystem. W trakcie procesu projektowania dokument projektowy staje się dokumentem żywym, rozwijającym się wraz z procesem projektowania, gdy każdy podukład jest projektowany i wdrażany.
Zamierzeniem dokumentu projektowego jest uchwycenie istotnych informacji o projekcie wykraczających poza zakres schematu, rysunków wykonawczych i montażowych.
Etap specyfikacji to kolejny obszar, który często jest pomijany lub omijany z powodu ograniczeń czasowych i budżetowych. Dlatego należy z góry przeznaczyć czas i zasoby na właściwe opracowanie specyfikacji. Pracując w środowisku startupowym, gdzie czas i pieniądze są na wagę złota, wielokrotnie spotkałem się z sytuacją, gdy zadaniem było projektowanie produktów przy niejasnych lub nieistniejących specyfikacjach. Podejście to jest pełne ryzyka. Projektowanie przy nieistniejącej lub zmiennej specyfikacji prowadzi do nigdy niekończącej się historii rozwoju. Specyfikacja ma za zadanie powiedzieć, co masz osiągnąć i zweryfikować, kiedy projekt jest zakończony. Zbyt często utrzymuje się mentalność „możemy to zrobić lepiej”, a projekt kończy się przekroczeniem budżetu i opóźnieniami, co jest kluczowym powodem, dla którego nie zajęto się specyfikacją na początku.
Często specyfikacja urządzenia, które jest przedmiotem dokumentu projektowego, będzie podsystemem znacznie większego systemu. Prezentowana jest specyfikacja całego systemu, a następnie części specyfikacji systemu, które dotyczą danego urządzenia, są prezentowane w logiczny i uporządkowany sposób.
Specyfikacja powinna zawierać (ale nie ograniczać się do):
- Funkcja (co ma robić podsystem)
- Środowisko operacyjne (temperatura, wilgotność itp.)
- Interfejsy z innymi podsystemami
- Budżet mocy
- Dostępne napięcia zasilania
- Ograniczenia mechaniczne rozmiar/waga/kształt
- Wymagania dotyczące wstrząsów i wibracji
- Termiczne (dostępne chłodzenie, ograniczenia emisji cieplnej itp.)
- EMI emitowane, przewodzone i podatność
- Niezawodność.
Ponadto, lista jest długa…
Przegląd systemu opisuje system narracyjnie, używając jak najmniej terminów technicznych. Jest to opis architektury systemu na wysokim poziomie i powinien zawierać diagram architektoniczny pokazujący różne podsystemy i ich połączenia interfejsowe. Interfejsy z innymi zewnętrznymi podsystemami również powinny być omówione zarówno w narracji, jak i na diagramie.
Rozważania projektowe opisują wszelkie ograniczenia w projekcie systemu. Ta sekcja powinna odnosić się do przeprowadzonych studiów porównawczych oraz do wszelkich założeń przyjętych przez zespół projektowy podczas opracowywania projektu systemu. Ta sekcja powinna odnosić się do specyfikacji dla śledzenia.
Sekcja projektu podobwodów wyodrębnia każdy podobwód, takie jak oscylatory, wzmacniacze, MCU i inne drobne bloki funkcjonalne systemu. Każdy podobwód powinien mieć swoją sekcję zawierającą (ale nie ograniczając się do):
Tytuł powinien opisywać działanie obwodu.
Teoria działania powinna opisywać funkcjonalność obwodu w szczegółach technicznych na niskim poziomie. W razie potrzeby, należy odnieść się do punktu specyfikacji, który jest realizowany przez podobwód, dla śledzenia.
Schemat obwodu, Rysunek 1, może być skopiowany bezpośrednio z narzędzia do przechwytywania schematów jeśli funkcjonalność ta jest obsługiwana. W przeciwnym razie należy użyć narzędzia do edycji graficznej.
Rysunek 1: Schemat obwodu może być skopiowany z narzędzia do przechwytywania schematów.
Wszelkie obliczenia wartości komponentów muszą być przedstawione, takie jak rozpraszanie mocy wszystkich komponentów, gdzie jest to stosowne, stałe czasowe filtrów oraz inne obliczone parametry wydajności obwodu.
Jeśli przeprowadzono jakiekolwiek symulacje na podobwodzie, wyniki muszą być przedstawione. Należy również dostarczyć szczegółową charakterystykę techniczną wyników symulacji. W stosownych przypadkach należy odnieść się do pozycji specyfikacji, która jest spełniana przez podobwód, w celu zapewnienia śledzenia.
Rysunek 2: Wyniki symulacji muszą być uwzględnione.
Architektura interfejsu podsystemu, który jest szczegółowo opisany w dokumencie projektowym, musi być opisana w szczegółach technicznych. Wszelkie negocjowane konfiguracje sprzętowe między podsystemami muszą być szczegółowo omówione i odniesione do specyfikacji.
Sekcja cech mechanicznych zawiera fizyczne właściwości projektu. Informacje przekazywane w tej sekcji powinny obejmować, ale nie ograniczać się do kształtu płytki, wymiarów, wagi, środka masy (jeśli dotyczy) oraz kluczowych cech. W stosownych przypadkach należy cytować odniesienie do pozycji specyfikacji, która jest spełniana. Ta sekcja powinna zawierać diagram gotowego systemu, pokazany na przykładzie na Rysunku 3, z zaznaczeniem kluczowych cech, takich jak wymiary, wskaźniki, połączenie kablowe, duże komponenty oraz inne znaczące cechy projektu.
Rysunek 3: Wymiary mechaniczne i kluczowe cechy są szczegółowo opisane na rysunkach technicznych.
Gdy wymagają tego specyfikacje, należy przeprowadzić ostateczną analizę systemu. Końcowy projekt jest modelowany i analizowany, aby zweryfikować, czy spełnia on specyfikację. Typ danych, które mają być przedstawione w tej końcowej sekcji, odnosi się do wymagań systemowych dotyczących termiki, wstrząsów i drgań, niezawodności, EMI oraz dopasowania formy i funkcji. Często wymagany jest również model 3D, aby ukończyć dokumentację końcowego projektu.
Dokumentacja projektowa to dokument żywy i bardzo ważna część każdego projektu. Zapewnia ona śledzenie powrotnego do specyfikacji i jest integralną częścią określającą, kiedy faza projektowa jest zakończona. Dokumentacja projektowa nie zastępuje tradycyjnych dokumentów dotyczących fabrykacji sprzętu i montażu, ale powinna być postrzegana jako uchwycenie całego procesu projektowego.