Philosophie und Dokumentation

Als ich für Control Data (eigentlich eine Tochtergesellschaft) arbeitete, bekam jeder Schaltplan eine einfache Identifikationsnummer, die in aufsteigender Reihenfolge angeordnet war. Gleiches galt für mechanische Zeichnungen und Leiterplatten. Obwohl ich in der Dokumentationsabteilung angestellt war, muss ich zugeben, dass ich mich nicht erinnern kann, wie sie alle zusammenkamen, um den Minicomputer zu bauen, an dem wir arbeiteten.

Damals wurde alles von Hand erstellt – der Schaltplan wurde skizziert und an die Zeichenabteilung übergeben, die ihn auf Pergament (auch Pauspapier, obwohl beide Begriffe für jüngere Leser so fremd wie Kohlepapier sein können) mit oft Standardsymbolen übersetzten Gleichmäßigkeit mit Schablonen erreichen. Ein Fachzeichner legte die Leiterplatte mit Punkt und Klebeband aus und ein Maschinenbauer erstellte die Verpackung an einem Zeichentisch. Die bürointerne Kommunikation erfolgte über Memos, Berichte, Besprechungen und natürlich individuelle Interaktion. Ich habe einen Blog mit meinen Erinnerungen geschrieben, wie die Dinge waren „Wie es war:PCB-Layout von Rubylith zu Punkt und Band zu CAD“.

Mit der Verbesserung des computergestützten Designs wurden die Zeichnungen elektronisch mit einem Papierpfad, aber es war nur eine bequemere Möglichkeit, den Status quo in der Dokumentation zu implementieren. Was die Platine anbelangt, war der Schaltplan nur eine Möglichkeit, die Netzliste zu erhalten. Die mechanische Zeichnung erforderte ein oder zwei Schritte, um die PCB-Ausgabe in eine .dxf-Datei zu konvertieren, um sie in Autocad zu importieren. Es war einfach, die verschiedenen Dokumentausgaben zu trennen und zu kategorisieren.

Die Produkte, an denen ich arbeite, werden in Etappen gebaut, es gibt also Unterbaugruppen. Das hat uns schon immer beunruhigt. Nehmen wir an, wir haben verschiedene Builds mit unterschiedlichen Komponenten. In der Dokumentationshierarchie gibt es einen Punkt, an dem es einen Teilbuild gibt, der einen gemeinsamen Vorläufer darstellt. Auf welcher Ebene gehört der Schaltplan? Befindet es sich auf der frühesten Ebene, auf der keine Komponentenwerte zugewiesen sind, oder gibt es auf jeder der obersten Ebenen einen eindeutigen Schaltplan mit dem ausgewählten Komponentenwert. Bis zu einem gewissen Grad kann die Wahl bestimmt werden, wofür der Schaltplan verwendet wird:Wird er zum Debuggen des Systems verwendet, bietet er einen Überblick für die Produktion oder wird er für den Service verwendet.

Im Laufe der Jahre hat sich das Dokumentationssystem meines Arbeitgebers uneinheitlich und willkürlich weiterentwickelt. In Anbetracht der Tatsache, dass wir mehrere Personen hatten, die es beeinflusst haben und da sie ihre Erfahrungen aus anderen Organisationen mitgebracht haben, gehe ich davon aus, dass Ihnen allen Elemente davon bekannt vorkommen werden. Ein übergeordnetes Prinzip, das ich versucht habe umzusetzen, stammt aus der Luft- und Raumfahrtindustrie. Es gibt nur ein gegebenes Dokument und es kann nicht an zwei Stellen existieren, da die Pflege von mehr als einem umständlich und fehleranfällig ist.

Abbildung 1. Eines der etwas komplexeren Produkte, die wir herstellen. Die komplette Produktstückliste für A enthält Zeichnungen, die die Seitenschilder (B), das Gehäuse (C), die Zeichnungen für die Frontplatte (D), die Steckverbinder und Zeichnungen für die Beschriftung der Stecker (E &F), die Baugruppe (G) und nicht dargestellt die Unterlagen für die auf das Mikro zu programmierende Firmware auf G. Die Verpackung wird auch beigelegt. Die Baugruppe besteht aus einer Leiterplatte und allen darauf montierten Komponenten. Wo in der Hierarchie platzieren wir den Schaltplan? (Quelle:Autor)

Jedes von uns hergestellte Produkt hat eine Identifikationsnummer (meist fortlaufend vergeben), die wir „Katalognummer“ nennen. Alle Dokumente auf seiner (obersten) Ebene in der Hierarchie bestehen aus einem Buchstabenpräfix, der Katalognummer und einem Suffix der Revision. Zum Beispiel wäre der Schaltplan (Rev C) der Katalognummer 330924 W330924C, die mechanische Zeichnung (Ref F) wäre M330924F und die Stückliste (Rev G) wäre P330924G. Wenn es eine Unterbaugruppe gibt, wird ihr eine eigene fortlaufende Nummer zugewiesen (z. B. SB00123) und die Dokumente, die für diese Ebene benötigt werden, werden nach der gleichen Idee eines Präfix-SB00123-Suffix nummeriert. Dokumente sind nur dort vorhanden, wo sie gebraucht werden, und der Schaltplan würde beispielsweise auf das Niveau des gemeinsamen Vorgängers sinken. Komponentenwerte, die sich über Builds hinweg ändern können, sind mit einem Symbol gekennzeichnet, das angibt, dass der Wert in der Stückliste definiert ist. Mechanische Baugruppen und Firmware folgen derselben Idee. Ebenso bekommt die Platine eine fortlaufende Nummer und Revision – keine Präfixe.

Aber die CAD-Welt hat sich verändert und das Rätsel ist rätselhafter geworden. Pakete wie Altium integrieren viele Aspekte des Designs. Der Schaltplan, die Leiterplatte, die Montagezeichnung, die Mechanik und möglicherweise sogar die Firmware sind alle Teil derselben Designumgebung. So sehr, dass unser Zeichner darauf besteht, dass die Leiterplatte die physische Manifestation des Schaltplans ist und beide mit derselben Revision immer im Gleichschritt sein sollten. Wenn sich also ein Komponentenwert ändert, muss sich die PCB-Revision ändern! Wie geht's? Und darüber hinaus, welche Nummer ist den Schaltplänen, Montage- und mechanischen Zeichnungen zugeordnet, die jedes Mal geändert werden, wenn die Platine geändert wird (einschließlich möglicherweise trivialer Dinge wie Siebdruck-Updates)? Wo in der Hierarchie liegen sie – sind sie mit der Katalognummer oder der PCB-Nummer verbunden? Und wo werden sie abgelegt, damit der Konstrukteur beim Aktualisieren einer Zeichnung von der geänderten Zeichnung aus arbeitet und nicht die automatisch als Teil des PCB-Pakets gespeicherte? HILFE!

Kennt jemand ein modernes, konsistentes und wenn möglich irgendwo beschriebenes System, damit ich versuchen kann, unser System zu aktualisieren? Kennt jemand einen Doktoranden der Philosophie, der nach Dissertationsmaterial sucht? Bitte fügen Sie unten Ihre Gedanken und Beschreibungen Ihrer Erfahrungen hinzu.