Wie mache ich Hardware-Dokumentation?

10

Ich erstelle einige Folien für meine Klasse darüber, wie wir die Hardware dokumentieren sollen, die wir entwickeln.

Ich möchte die Dokumente auflisten, die wir beim Erstellen von Hardware erstellen sollten. Ich war begeistert von der UML-Softwaredokumentation, die für fast jede Situation viele Dokumenttypen bietet.

Nach meiner Erfahrung und Forschung haben viele Projekte nur die Schaltpläne, das Layout und die Stückliste. Ich denke, wir sollten auch Informationen über das Motiv (die Anforderungen) hinzufügen, die uns bei der Auswahl eines Mikrocontrollers und nicht des anderen veranlassen. Es gibt auch einige Informationen zum Layout, die wir einfach nicht schreiben, als spezielle Komponentenposition, die nicht geändert werden sollte.

Davon abgesehen:

Wie sollen wir unsere Hardware dokumentieren?
Welches ist das wichtige Dokument, das Sie haben möchten, wenn Sie Verbesserungen / Änderungen an einer anderen Hardware vornehmen müssen, die Sie noch nie gesehen haben?
Wie können diese Informationen klar organisiert werden?

documentation

— RMAAlmeida
quelle

1

Ich denke, diese Frage zu den zu erbringenden Leistungen enthält gute Ratschläge dazu, was gegeben werden muss, um die Ergebnisse eines hardwarebezogenen Designprojekts vollständig zu übergeben.

— Kortuk

Fotos !!!! Riesige Menge an Informationsgehalt und Informationsdichte, wenn sie gut verwendet werden.

— Russell McMahon

Danke Kortuk. Das ist die Art von Informationen, nach denen ich gesucht habe, aber ich denke immer noch, dass wir mehr Informationen darüber benötigen, wie das Projekt entwickelt wurde und warum der Ingenieur einige Entscheidungen getroffen hat.

— RMAAlmeida

3

Ich stimme Ihrem dritten Absatz voll und ganz zu. Abgesehen von den offensichtlichen Dingen wie Schaltplänen, Stücklisten usw. gibt es weniger greifbare Dinge wie, wie Sie sagen, warum Sie eine bestimmte Komponente ausgewählt haben und genauso wichtig, warum Sie keine vielleicht offensichtlichere Komponente ausgewählt haben.

Jetzt zeige ich hier vielleicht mein Alter, aber ich verwende immer noch gerne ein gebundenes Logbuch, um meine Denkprozesse und Designentscheidungen aufzuzeichnen - auch die falschen. Wenn jemand in Zukunft versucht, eine Komponente durch eine besser geeignete zu ersetzen oder eine Spur auf der Leiterplatte zu verschieben, können meine Notizen darauf hinweisen, dass ich bereits dort war und mir die Finger verbrannt habe (vielleicht buchstäblich!).

Ich nummeriere immer die Seiten und erlaube ein paar Seiten vorne als Inhaltsverzeichnis. Sie können auch Dinge wie Berechnungen der Verlustleistung, Toleranzen, Zeitangaben usw. dokumentieren (diese Angewohnheit stammt aus meiner Zeit in der Luft- und Raumfahrtindustrie, als die Führung eines Logbuchs obligatorisch war). Natürlich können Sie diese Informationen jederzeit in ein WP-Dokument einfügen, aber ich bleibe beim Papier!

Schaltungsbeschreibungen können auch angebracht sein, wenn ungewöhnliche (insbesondere analoge) Schaltungen betroffen sind. Ich würde diese wie Softwarekommentare behandeln, um nicht offensichtliche Schaltungs- oder Komponentenfunktionen zu dokumentieren. Schaltpläne wie Software sollten sich so weit wie möglich selbst dokumentieren, aber manchmal reicht dies nicht aus.

Eine aktuellere Alternative, insbesondere in einem Bildungsumfeld, könnte eine Projektwebsite sein. Dies könnte als eine Sammlung von Blogs für jede Disziplin arrangiert werden - Hardware-Design, Leiterplattenlayout, Software usw. Die Blog-Natur würde es den Mitwirkenden ermöglichen, ihren Gedankenfluss zu zeigen und den laufenden Fortschritt des Projekts zu dokumentieren, während andere Seiten formeller sein könnten (Fortschritt) Gantt-Diagramme, Testergebnisse usw.). Sie können sogar Besprechungsprotokolle und Aktionslisten hinzufügen. Hyperlinks erleichtern Querverweise und jetzt haben wir MathJax, sodass auch Entwurfsgleichungen einfach einzufügen sind.

— MikeJ-UK
quelle

Zu diesem Zweck gibt es weitaus bessere Online-Tools als eine Sammlung von Blogs. Bei der Arbeit verwenden wir (~ 500 Ingenieure) das Redmine- Projektmanagement für seine Tools für Wiki, Fehlerverfolgung und Versionskontrolle, aber es gibt viele Alternativen . In der Schule verwenden wir Google Sites und Docs.

— Kevin Vermeer

@ Kevin Vermeer - Der letzte Absatz wurde nachträglich hinzugefügt. Ich bin noch nie auf Redmine gestoßen, aber es sieht für diesen Zweck großartig aus, da es weit über das grundlegende Projektmanagement hinauszugehen scheint. Viele Werkzeuge sind in einem oder zwei Bereichen großartig und in anderen fehlen sie.

— MikeJ-UK

Für jedes Projekt, das sich mit Design befasst, sollte ein Laborheft geführt werden, das schriftliche Notizen enthält, in denen hervorgehoben wird, warum Entscheidungen getroffen wurden, die in Schaltplänen festgehalten sind, regelmäßige Zeugenunterschriften ... Diese Art von Dingen macht Anwälte für geistiges Eigentum glücklich und dokumentiert auch die Art von Sachen, über die OP spricht

— Scott Seidman

2

Wie sollen wir unsere Hardware dokumentieren?

Welches ist das wichtige Dokument, das Sie haben möchten, wenn Sie Verbesserungen / Änderungen an einer anderen Hardware vornehmen müssen, die Sie noch nie gesehen haben?

Wie können diese Informationen klar organisiert werden?

In unserem Unternehmen wird von uns erwartet, dass wir Dokumente zur Beschreibung des Hardware-Designs schreiben. Diese sind ziemlich einfach: Sie erklären zu Beginn, was die Schaltung tun soll, und gehen dann in jedem Abschnitt ins Detail. Jeder Komponentenwert soll auf irgendeine Weise gerechtfertigt sein: Wenn Sie "Standard" -Pullup- oder Serienwiderstände haben, sollten diese am Anfang in einem Hinweis erwähnt werden (z. B. "10K-Pullups und 0,1 uF-Bypass-Kondensatoren werden verwendet, sofern nicht anders angegeben"). Andernfalls müssen die Auswahlmöglichkeiten für Komponentenwerte erläutert werden. zB "4,7 K und 0,1 uF RC-Filter (tau = 0,47 ms) zur Begrenzung von Hochfrequenzkomponenten" oder "NLAS4051-Multiplexer für geringe Leckage - dieser Schaltungsknoten ist empfindlich".

— Jason S.
quelle