Jak dokumentujesz swoje decyzje dotyczące projektowania sprzętu?

43

Jak dokumentujesz swoje decyzje dotyczące sprzętu na etapie projektowania? Jak uniknąć zadawania sobie następujących pytań podczas przeglądania projektu sprzętu wykonanego w przeszłości:

  • Dlaczego wybrano ten komponent?
  • Dlaczego / jak wybrałem te konkretne parametry dla tego komponentu?
  • Co robi ta część obwodu?
  • Jakie jest rozpraszanie mocy przez ten komponent?
  • Jaki jest całkowity pobór mocy tego obwodu?
  • Czy mogę wymienić ten komponent na inny? Czy są jakieś równoważne komponenty do tego komponentu? itp.

Jaki jest dobry sposób na udokumentowanie swoich decyzji i obliczeń podczas fazy projektowania obwodu? Jak uzyskać odpowiedzi na powyższe pytania bez ponownego przeglądania setek stron arkusza danych?

Jednym ze sposobów, w jaki mogłem wymyślić, jest dodawanie notatek do plików schematów (jeśli obsługuje je EDA), ale nie chciałbym zaśmiecać schematu zbyt dużą ilością informacji.

m.Alin
źródło
1
Kto zobaczy te szczegóły? Czy są tylko dla odniesienia, czy będą widziane przez innych?
stanri
@Stacey Dokumentacja jest przeznaczona zarówno dla mnie, jak i dla innych projektantów. Chciałbym, aby większość moich przyszłych projektów była typu open source i bardzo ważne jest, aby były one odpowiednio udokumentowane.
m.Alin
9
@Stacey Ale naprawdę .. jaka jest różnica? Po chwili spojrzysz na swój projekt, jakbyś pierwszy raz go zobaczył.
m.Alin
2
Różnica polega na sposobie prezentacji informacji. Formalny dokument wyjaśniający każdą decyzję w profesjonalnym tonie będzie o wiele więcej pracy niż szybkie zapisywanie formuł i odnotowywanie wybranych wartości. Dodatkowo, jeśli ktoś zobaczy te notatki, ważny jest fakt, że są one cyfrowe.
stanri
4
OMG Podoba mi się to pytanie. (Przepraszam, wiem, że to naprawdę nie pomaga, ale nad tym teraz pracuję, więc to świetnie). Kontynuować.
efox29

Odpowiedzi:

15

Osobiście wybieram staroświecką trasę: mam notatnik do projektowania, w którym zapisuję absolutnie wszystko o decyzjach projektowych, które podejmuję. W szczególności wybór komponentów i wartości, obliczenia prądu, obliczenia zasilacza, wszystko. Dokumentuję również decyzje dotyczące oprogramowania / oprogramowania układowego oraz uwagi dotyczące czasu i wykorzystania zasobów.

Każdy notebook ma stronę z treścią, która odnosi się do określonej części projektu (zasilacz itp.), A wszystkie strony są ponumerowane.

Wiele razy zastanawiałem się nad przejściem na technologię cyfrową, ale fajnie jest mieć ze sobą mój notatnik, gdy pracuję, a pisanie formuł cyfrowych jest dość niewygodne. O wiele łatwiej jest pisać obliczenia ręcznie.

Przygotowując specyfikację lub formalną dokumentację do projektu płytki, zwykle odnoszę się do mojego notatnika jako odświeżenia tego, co zrobiłem (lub piszę jednocześnie dokumentację cyfrową). Chociaż może się wydawać, że robię to samo dwa razy, stwierdzam, że moje zeszyty są dla mnie prawie w całości obliczeniami i wyjaśnieniami, a dokumentacja jest znacznie mniej szczegółowa, a dla innych bardziej formalna i objaśniająca. W związku z tym często nie piszę tego samego dwa razy.

stanri
źródło
Zgadzam się całkowicie w kwestii formuł, ale przestałem używać papierowych notatek około 5 lat temu. Wpisanie jest o wiele łatwiejsze niż pisanie, i ma wszystkie typowe zalety elektronicznych tekstem - przeszukiwać, sendable, backupable itd
markt
2
Niektóre z najbardziej imponujących / ważnych zeszytów projektowych naszych czasów: computerhistory.org/collections/fairchild . Jedną znaczącą zaletą papierowego dziennika / notatnika jest rysowanie. Narysowanie / szkicowanie rzeczy na moim laptopie wymaga znacznie więcej wysiłku (choć na iPadzie jest to łatwiejsze - na przykład moja żona trzyma notatki na swoim iPadzie). Zwykle myślę graficznie, więc dużo projektuję, rysując schematy blokowe.
slebetman,
11

Możesz wrócić i zaktualizować specyfikację projektu o te informacje. Lub weź specyfikację i utwórz specyfikację niższego poziomu, w której bardziej szczegółowo opisujesz, co zamierzasz zrobić i dlaczego, najlepiej przed rozpoczęciem schematów :). Następnie aktualizuj i postępuj zgodnie ze schematami.


Odpowiedzi na pytania poniżej: Cóż, zwykle robimy to od wymagań marketingowych, a następnie może formalnej odpowiedzi inżynierskiej lub po prostu nieformalnej dyskusji. Po tym następuje MRD (dokument wymagań marketingowych), słowem, przy użyciu naszego szablonu. Obejmuje to wymagania, analizę konkurencji, wielkość rynku, możliwości, szacunkowe koszty rozwoju itp. Zwykle jest to napisane przez osobę zajmującą się marketingiem (lub kogoś powyżej mojej kategorii płac).

Po nim następuje PRD (dokument wymagań produktu) napisany zwykle przez inżynierów, również w szablonie słów. Opisuje to bardziej szczegółowo techniczne, co zrobi produkt, jakie elementy są wymagane, a na wysokim poziomie, jak każdy z nich będzie działał. Często uwzględnimy tutaj docelową wydajność, cenę, moc, rozmiar i inne wskaźniki.

Następnie podano szczegółowe specyfikacje funkcjonalne dla każdej sekcji. Niektóre prace projektowe są tu właściwie wykonywane na długo przed wprowadzeniem ich do schematu. Na przykład obliczona zostanie moc, zostaną wybrane części i przeprowadzone zostaną liczne badania. To miejsce, w którym udokumentowalibyśmy wszelkie nieoczywiste decyzje projektowe.

W końcu przejdziemy do schematów, które w tym momencie są łatwe, ponieważ wiele trudnych prac projektowych wykonano na etapie specyfikacji. Moim zdaniem należy to zrobić :) Jeśli coś zmieni się na etapie schematu, na przykład stwierdzimy, że coś nie zadziała lub po korytarzu wybiegnie marketingowiec, mówiąc, że teraz musi być czerwony zamiast niebieskiego, wtedy wróci i zaktualizuje specyfikacje.

Wszystkie specyfikacje, PRD, MRD są przechowywane w SVN z linkami do dokumentów na wewnętrznej wiki. Zmiana specyfikacji spowoduje aktualizację SVN i powiadomienie zainteresowanych stron. Oczywiście możesz po prostu trzymać go ręcznie w folderze współdzielonym.

To mniej więcej mój proces, wydaje mi się, że możesz chcieć udokumentować każdą drobną decyzję dotyczącą projektu i zdecydowanie tego nie robimy. Nie mówiąc, że nie powinieneś, widziałem, gdzie byłoby to pomocne. Chyba zwykle cały czas dokumentujemy, jak, a nie dlaczego.


Ok, może powinienem był również odpowiedzieć na każde pytanie :)

Jeśli robisz obliczenia, może w Excelu? Lub na papierze i uważasz, że wyniki i metoda są ważne dla zrozumienia i zaprojektowania obwodu, to powinieneś je uwzględnić w odpowiedniej sekcji specyfikacji projektowej. Nawet jeśli oznacza to zrobienie zdjęcia rysunku ręki :)

Dlaczego wybrano ten komponent? Myślę, że funkcjonalna specyfikacja jest dobrym miejscem do tego, nie trzeba zwariować, ale tylko prosta linia lub dwie o tym, jakie były jej zalety. Zarezerwowałbym to na krytyczne elementy, nie sądzę, że chcesz opisać, dlaczego wybrałeś na przykład rezystor podciągający.

Dlaczego / jak wybrałem te konkretne parametry dla tego komponentu? Połącz to z powyższym.

Co robi ta część obwodu? Byłoby to częścią twojej specyfikacji funkcjonalnej, jeśli obwód jest wystarczająco ważny, aby uzasadnić to pytanie, powinien mieć własną sekcję specyfikacji.

Jakie jest rozpraszanie mocy przez ten komponent? Jeśli mówisz o zasilaczu, umieść to w sekcji zasilania, również chcę to zauważyć na schematach. Naprawdę, chociaż wszystkie moje części pochodzą z bazy danych, a schemat jest bezpośrednio z nimi powiązany, dzięki czemu możemy łatwo zobaczyć parametry, arkusz danych itp. Ale jeśli masz tylko wydruk, miło jest to wiedzieć.

Jaki jest całkowity pobór mocy tego obwodu? Myślę, że należy to do sekcji zasilania w specyfikacji.

Czy mogę wymienić ten komponent na inny? Czy są jakieś równoważne komponenty do tego komponentu? itp. Myślę, że należy to do twojego BOM lub dowolnego innego procesu stosowanego do produkcji. Części alternatywne mają ułatwić pozyskiwanie. Ponownie dla nas to wszystko pochodzi z bazy danych części.

Jakiś facet od sprzętu
źródło
Zdałem sobie sprawę, że muszę udokumentować swój projekt (stąd pytanie), ale nie znam dobrej metody, aby to zrobić. Czy zapisuję swoje notatki w pliku tekstowym, czy umieszczam je bezpośrednio na schemacie, czy zapisuję notatki na papierze, a następnie je skanuję? Jak zachować synchronizację notatek decyzyjnych z projektem i co naprawdę powinny one zawierać? Jaka metoda dokumentacji działa dla Ciebie?
m.Alin
1
@ m.Alin SHG wydaje się działać jak ja i ma specjalny dokument, który jest wykonywany przed rozpoczęciem pracy nad schematem. Dokument ten powinien zawierać szczegółowe wymagania dotyczące obwodu, informacje o całym systemie, uzasadnienie głównych decyzji itp. Dokumentuje to twój proces myślowy i wymienia wymagania, które możesz następnie podjąć, aby zaprojektować swój schemat. To jest sposób, aby przejść w profesjonalnym otoczeniu, ale możesz uciec od notebooków i tym podobnych, jeśli projektujesz w domu. I zazwyczaj zachować folder na moim serwerze pracować z
I. Wolfe
1
Zabrakło mi miejsca ... - z dokumentem specyfikacji, wszelką dokumentacją testową, wszelkimi schematami blokowymi całego systemu, arkuszami danych dla dowolnych krytycznych części itp. To wszystko w jednym podfolderze (folderze planowania / specyfikacji) w folderze projektu. W osobnym folderze będę miał schemat, układ pcb i wszelką odpowiednią dokumentację montażu / produkcji. Idealnie byłoby, gdyby ktoś mógł uzyskać wszystkie potrzebne informacje z jednego dokumentu, ale czasami nie ma potrzeby poruszania się po arkuszu danych lub szczegółowych informacji / obliczeniach testowych.
I. Wolfe
dodał kilka komentarzy na temat naszego wbudowanego procesu
Some Hardware Guy
4
+1 za użycie kontroli wersji dla dokumentów krytycznych. Każdy powinien z niego korzystać, nawet pojedynczy, samozatrudniony inżynier.
Lior Bilia,
5

Robię dużo szybkich projektów i muszę powiedzieć: adnotacja na schemacie jest zdecydowanie najwygodniejsza. Rzadko zdarza się, że którykolwiek z moich projektów ma więcej niż 2 lub 3 arkusze A4, więc liczba decyzji dotyczących projektu jest ograniczona. Wiele decyzji projektowych odbywa się prawie automatycznie; Nie muszę podawać powodów każdej części. Tylko jedna lub dwie główne części i może jakiś filtr lub czujnik pasywny. Reszta jest natychmiast oczywista dla każdego doświadczonego inżyniera.

Co do twojego ostatniego pytania: części alternatywne zasadniczo nie są decyzją projektową, ale decyzją dotyczącą zaopatrzenia, i jako taka jest częścią twojego procesu pozyskiwania. W moim przypadku części alternatywne są we właściwościach części i są pozyskiwane automatycznie, jeśli zapasy wyczerpią się na części podstawowej lub źródle.

W przypadku większych projektów i projektu systemu zwykle używam Dokumentów Google z szablonem dokumentu projektowego.

W podsumowaniu; Osobiście uważam, że zwarty przepływ pracy ostatecznie się opłaci. Posiadanie wielu oddzielnych plików z informacjami projektowymi (oddzielny projekt systemu, dokumenty decyzji projektowych, dokumenty źródłowe, wszystkie oddzielone od podstawowych plików schematu i układu) powoduje wiele (mentalnych) bałaganu i wymaga przełączania kontekstu za każdym razem, gdy chcesz przejrzeć projekt decyzja. Posiadanie wszystkiego w jednym miejscu działa dobrze. Jeśli twój schemat zaczyna wyglądać na zagracony, nie stanowi to problemu w tym przepływie pracy, ale raczej oznacza, że ​​prawdopodobnie powinieneś lepiej podzielić projekt na części, użyć więcej arkuszy lub użyć większych arkuszy.

użytkownik36129
źródło
3
Zwykle lepiej jest mieć specjalny dokument, przynajmniej w profesjonalnym otoczeniu. Na przykład, jeśli chcę wiedzieć, dlaczego wybrałem wartość bezpiecznika, dobrze byłoby wiedzieć, że moja moc pobiera 700mA dla 50uS, a następnie 300mA przez 3s. Ta informacja po prostu zaśmieca schemat, w którym wszystko, co naprawdę musisz umieścić, to bezpiecznik, ale może być potrzebny w pewnym momencie. Są też okoliczności, w których miałem 6 serwomechanizmów z jednego regulatora i muszę wiedzieć, ile silników będzie działać jednocześnie. Znowu coś jest potrzebne, ale nie na schemacie.
I. Wolfe,
1
Oczywiście opinie będą się różnić. Mówię tylko, że przy ponad 200 projektach pod moim pasem stwierdzam, że działa to naprawdę dobrze. „Profesjonalista” nie musi oznaczać ścisłego protokołu i metodologii; w przypadku stosunkowo małych projektów (stanowiących większość tego, co robię) działa to dobrze. Większe projekty, a zwłaszcza projekty oparte na współpracy (co obecnie jest bardzo rzadkie, nawet rzeczy takie jak Raspberry Pi są projektowane i układane przez tego samego faceta) wymagają jednak nieco więcej.
user36129,
4

W przypadku wielu moich mniejszych projektów generalnie umieszczam prostą zieloną etykietę i obramowanie wokół obwodów. W przypadku większych projektów niektóre oprogramowanie eCAD pozwala budować od schematu blokowego w dół, gdzie każdy arkusz dodatkowo opisuje pojedynczy blok. Sztuka rozkładania każdego problemu i zarządzania kompromisami (to inżynieria IMHO). Tam, gdzie jest pewna analiza wyboru komponentów, takich jak filtrowanie analogowe, zanotuję częstotliwość odcięcia i typ filtra (np. Filtr dolnoprzepustowy (f_c = 100Hz))

Typowe bloki, z którymi się spotykam, obejmują:

  • Zarządzanie energią (regulatory napięcia, zabezpieczenie przed odwrotną polaryzacją, diody TVS, wyłącznik zasilania, osłony bypassu itp.)
  • MCU (mikrokontroler, programowanie nagłówka lub padów, zaślepki układu obejściowego)
  • Wskaźniki (np. Diody LED, przewód EL, wyświetlacz 7-segmentowy, silnik wibracyjny)
  • Wykrywanie określonej funkcji (np. Wykrywanie prądu, wyczuwanie dotykowe, GSR, aktywność, wykrywanie otoczenia itp.)
  • Debug Comms (ferrytowy koralik, USB, I2C, UART, SPI, jakiś sposób na uzyskanie informacji)
  • Radio (wszystkie elementy obsługi wielu radiotelefonów)
  • Wideo (wszystkie komponenty pomocnicze i układy do kamery)
  • Pamięć zewnętrzna (np. Zewnętrzna pamięć flash, układ EEPROM do przechowywania ustawień itp.)
  • Każda inna funkcja unikalna dla twojego projektu

Dzięki tym podblokom wyraźnie zorganizowanym i oznaczonym, mogę zużyć schemat zwykle w mniej niż kilka minut.

tarabajt
źródło
3

Prowadzę notatnik projektowy i dokładnie dokumentuję potrzeby / potrzeby. W przypadku najwcześniejszych prototypów dokonam wyboru części, notując wszystkie prawdziwe decyzje. Do kolejnych zmian używam dość formalnego procesu FMEA, dokumentującego, która potrzeba nie jest zaspokojona, aby uzasadnić zmianę - ponieważ oczywiście, jeśli nie ma niezaspokojonej potrzeby, nie ma potrzeby zmiany!

Jeśli jestem wystarczająco rygorystyczny, mogę wyśledzić każdą zmianę projektu (sprzęt, oprogramowanie, mechanika) według potrzeb.

Wszystkie wersje wszystkich rzeczy są śledzone przy użyciu subversion.

Może to być istotny element pliku historii projektu, który jest koniecznością dla FDA.

Scott Seidman
źródło
3

Często korzystałem z keynote (możesz także wybrać PowerPoint). Ma to tę zaletę, że pozwala na stosowanie ograniczeń ekranowych w oprogramowaniu symulacyjnym, takim jak SPICE GUI i tym podobne.

Naprawdę kluczowa jest dla mnie umiejętność upuszczania fragmentów z arkuszy danych i oznaczania ich, aby pokazać względne znaczenie w moich decyzjach projektowych. Mogę również dołączyć zdjęcia wczesnych obwodów drukowanych lub tablic rejestracyjnych oraz linki do artykułów, których użyłem przy wyborze projektu.

Uważam też, że zwykle chcę robić matematykę i rysunki ołówkiem na papierze. Więc robię zdjęcie moim telefonem i upuszczam je w dyskusji bez ponownego wpisywania. Czasami dla krótkich równań mogę użyć LaTeXa i wrzucić to.

Mogę również dołączyć wykresy sporządzone przez oprogramowanie naukowe, takie jak oktawa.

W dzisiejszych czasach, szczególnie w przypadku zadań wymagających dużej mocy obliczeniowej, mogę wykonać niektóre z tych prac w notebookach IPython, ale nie zrobiłem tego specjalnie w projektowaniu obwodów, tylko w obliczeniach fizycznych.

Wreszcie, Keynotes / Powerpoints można łatwo upodobnić dla innych i wyeksportować jako pdf do dystrybucji wśród osób nie / mniej technicznych.

ZSG
źródło
3

Umieść uwagi techniczne na schematach i w razie potrzeby utwórz więcej arkuszy. Zawsze umieszczam uwagi techniczne na wszystkich moich schematach, ponieważ w moim świecie może być konieczne ponowne odwiedzanie 1/2 upieczonych projektów przez pewien czas, a następnie ponowne umieszczanie ich na tylnym palniku podczas wybierania innego projektu; bardzo płynny przepływ projektowy. Te notatki EE pomagają mi i innym przyzwyczaić się do założeń projektowych przy niewielkim wysiłku. Używam również różnych kolorów tekstu / grafiki, aby wskazać ważność lub kontekst. Przykład poniżej ...wprowadź opis zdjęcia tutaj

Steve
źródło