Elektronik-Steckverbinder richtig dokumentieren – eine einfache Richtlinie

Wenn in einem Elektronikprojekt ein Steckverbinder verwendet wird, sollte die Pinbelegung immer dokumentiert werden – wenn dies vergessen wird, wird man zu 100% dabei erwischt, die eigene Pinbelegung zurückzuentwickeln (Frag nicht, woher ich das weiß). Das ist ein Prozess, der leicht ein paar Stunden dauern kann, während man die Pinbelegung hätte dokumentieren können.

Hier ist eine einfache Strategie, um die Pinbelegung zu dokumentieren.

1. Ein Foto mit dem Handy aufnehmen

Es muss nicht schön aussehen, hier wird kein Kunstwerk erstellt. Die einzigen Anforderungen sind, dass der Steckverbinder in seinem Kontext sichtbar ist und dass er erkennbar ist:

• Bei einem Steckverbinder auf einer PCB sicherstellen, dass einige Merkmale um den Steckverbinder auf der Platine erkennbar sind und dass Aussparungen oder andere Merkmale des Steckverbinders leicht erkennbar sind
• Bei einem Steckverbinder an einem Kabel sicherstellen, dass die Kabelklemme oder ein anderes Kabel erkennbar ist

Der relevante Bereich kann aus dem Foto ausgeschnitten werden, aber sicherstellen, dass ausreichend Platz darum bleibt (insbesondere bei PCB-Steckverbindern), damit man

Beispiel: PCB:

Beispiel: Kabel-Steckverbinder

2. Pins dokumentieren

Nun das Bild in eine Zeichensoftware laden. Ich verwende meistens draw.io, das im Browser verwendet werden kann, aber Inkscape funktioniert ebenfalls einwandfrei. Es kann auch eine Pixel-Bildbearbeitungssoftware wie GIMP oder Paint verwendet werden, aber ich empfehle stattdessen eine Vektor-Zeichnungssoftware zu verwenden, da es viel einfacher ist, später Informationen zu ändern, wenn eine Vektorgrafik-Software verwendet wird. Word kann auch verwendet werden, aber DrawIO ist in der Regel einfach weniger umständlich.

Texte platzieren, um die Funktion der Pins zu annotieren, und Linien vom Text zum eigentlichen Pin ziehen. Eine Signalfarbe wie Rot verwenden, damit die Annotationen deutlich sichtbar sind.

Dabei geht es absolut nicht darum, es gut aussehen zu lassen. Solange klar ist, welcher Pin zu welcher Annotation gehört, immer schnell vor schön bevorzugen. Der Versuch, es gut aussehen zu lassen, kostet nicht nur Zeit, sondern lenkt auch von der Kernaufgabe ab, es eindeutig zu machen.

Auch besondere Merkmale wie die Klemme eines Steckverbinders oder eine Aussparung (die Pin 1 anzeigt) in einer anderen Farbe dokumentieren.

Beispiel: PCB:

Beispiel: Kabel-Steckverbinder

3. Bei Kabel-Steckverbindern: Farben dokumentieren, die mit den jeweiligen Pins verbunden sind

Dieser Schritt kann übersprungen werden, wenn ein Steckverbinder auf einer PCB dokumentiert werden soll.

Bei Kabeln soll sichergestellt werden, dass bei der Herstellung z.B. eines Ersatzkabels die richtige Drahtfarbe an den Steckverbinder gelötet/gecrimpt/etc. wird.

Ich schlage vor, dies mit einer anderen Farbe wie Grün zu tun.

Beispiel:

4. Aufschreiben, was genau dokumentiert wird

Typischerweise über dem Foto Metadaten angeben, was dokumentiert wird. Ich schlage vor, dies immer im Diagramm zu tun (im Gegensatz zum bloßen Einfügen des Diagramms in ein Word-Dokument und Aufschreiben dort), da es weniger wahrscheinlich ist, dass das Diagramm von seinen Metadaten getrennt wird. Es kann jedoch trotzdem in ein Dokument geschrieben werden, in dem das Diagramm enthalten ist – es gibt keinen Grund, dieselbe Information nicht zweimal zu haben (manchmal hilft es, Fehler nach Änderungen zu erkennen).

Immer aufschreiben:

• Den Namen des Projekts, z.B. ESP32 Kühlschrank-Controller
• Den Namen des Steckverbinders innerhalb des Projekts, z.B. Debug-Steckverbinder
• Den Typ des Steckverbinders, z.B. Typ des Steckverbinders: RJ10 (4P4C). Falls zutreffend, auch Informationen darüber angeben, wo der Steckverbinder gekauft wurde, Bestellnummer des Herstellers
• Alle Informationen, die Kontext zu den Annotationen geben, wie z.B. UART aus Sicht des ESP32
• Die Revisionsnummer des Projekts, z.B. R1.0. Wenn kein Revisionssystem vorhanden ist, einfach R1.0 nennen, die nächste R2.0 etc.
• Das Datum, an dem die Zeichnung erstellt (oder geändert) wurde, z.B. 2022-10-06. Ich empfehle, ausschließlich das ISO8601-Format (YYYY-MM-DD) zu verwenden, um Verwechslungen von Tag/Monat zu vermeiden.

Im Allgemeinen ist mehr Information besser. Was jetzt offensichtlich erscheint, wird morgen (oder für jemand anderen) völlig unklar sein.

Beispiel:

5. Ergebnis dort speichern, wo es gefunden wird, wenn es am nötigsten ist

Ich empfehle immer, die Steckverbinder-Dokumentation sowohl als unveränderliches Dateiformat (d.h. ein Format, das nicht zum Bearbeiten gedacht ist) wie PDF, PNG, JPG als auch im Originalformat der Zeichensoftware (.xml oder .drawio) für DrawIO zu speichern.

Wenn das Projekt in git verwaltet wird, beide Dateien in das Git-Repository hochladen. Wenn eine Projektmanagement-Software wie redmine verwendet wird, die Dokumentation auch dort hochladen. Es kann absolut an mehrere Orte hochgeladen werden, deshalb haben wir oben ein Datum und eine Revisionsnummer verwendet – der wichtigste Aspekt ist, dass es leicht zu finden ist.

6. Weiterführende Literatur

Möglicherweise sind auch die folgenden Beiträge interessant:

• Dieser Beitrag ist neu, daher habe ich bisher keine verwandten Beiträge :-)