Projektdokumentation - wie macht ihr das?

Liebe Forumsmitglieder! Ich wollte mal fragen wie Ihr Eure Projekte dokumentiert. Also ich kommentiere natürlich den Code sehr ausführlich... zum Beispiel den Header

/***********************************************************
  Riegelschloss
  Autor: xxx xxxx xxxxxxx
  Datum: 07.02.2016

  Verwendete Hardware:
  RXB8 433 MHZ Reveiver
  Relais fuer das Schalten des Schlosses 12V
  Riegelschloss 12V
  RFID-RC522 RFID-Leser



  Libraries:
  RC-Switch (Funksignale)
  SoftwareSerial(RFID)
  SPI

  PINS:
  VCC_PIN 5 fuer 433 MHZ Receiver
  GND_PIN 2 fuer 433 MHZ Receiver
  DATA_PIN 3 fuer 433 MHZ Receiver
  BOLT_PIN 7 fuer Riegelschloss

  RST_PIN 9 RFID
  SS_PIN 10 RFID

  LED_ROT 4 fuer rote LED
  LED_GRUEN 8 fuer rote LED

***********************************************************/

Im Code selber natürlich auch...

Aber mit den Schaltungen habe ich mangels Kenntnis einige Probleme: In Fritzing finde ich nicht alle Bauteile, die ich verwende (nicht mal den Funk-Empfänger) :( Eagle hab ich mir runtergeladen, aber keinen Plan wie und was ich da machen kann/soll.

Eigentlich möchte ich meine Projekte, die dann auch im "echten Leben" eingesetzt werden sollen so dokumentieren, dass man sich gut auskennt, und da gehört auch ein Fritzing oder Eagle dazu...

Habt ihr Tipps für einen Neueinsteiger beim Dokumentieren von Schaltungen? ::)

Danke, Claus

Was ich letztens gefunden habe: http://www.digikey.com/schemeit/

Ist rein Online und danach kann man seine Schaltung als Bild exportieren. Die letzte Schaltung bleibt gespeichert. Mit einem DigiKey Account kann man aber auch Schaltungen abspeichern und wieder öffnen!

Vielleicht nicht die beste Lösung für komplexe Pläne, aber gut für einfache Dinge.

Fritzing kannst du für einen Schaltplan getrost in die Tonne treten. Dort macht lediglich die Breadboard Ansicht für ganz wenige Sachen Sinn. Für Schaltpläne sollte schon etwas besseres her, Eagle, KiCad, Zettel und Stift, ...

Du wirst bei den wenigsten Cad Programmen all deine Komponenten wiederfinden! Schau dir die Trainingshandbücher/Bedienungsanleitungen/Tutorials zu diversen Cad-Programmen an. Wenn ein Bauteil nicht zu finden ist, sowohl im Programm als auch im Netz, dann macht man sich selber eines.

sschultewolter: Fritzing kannst du für einen Schaltplan getrost in die Tonne treten. Dort macht lediglich die Breadboard Ansicht für ganz wenige Sachen Sinn. Für Schaltpläne sollte schon etwas besseres her, Eagle, KiCad, Zettel und Stift, ...

Ja, das habe ich mir schon so gedacht, Fritzing ist für die Beispiele aus den Einsteigerbüchern okay, aber sobald man Dinge miteinbezieht die über die KITS hinausgehen, ist es schnell aus....

sschultewolter: Du wirst bei den wenigsten Cad Programmen all deine Komponenten wiederfinden! Schau dir die Trainingshandbücher/Bedienungsanleitungen/Tutorials zu diversen Cad-Programmen an. Wenn ein Bauteil nicht zu finden ist, sowohl im Programm als auch im Netz, dann macht man sich selber eines.

Grundsätzlich kein Problem, allerdings hab ich halt so überhaupt keine Erfahrung und mein "Riegelschloss-Projekt" soll schon sehr bald zum Leben erweckt werden.... Dann werde ich wohl mal Zettel und Bleistift nehmen und später nachdokumentieren...

lg, Claus

An der Zettel und Stift Methode ist überhaupt nichts verkehrt. Meist bei weitem besser als was man für Zeichnungen/"Schaltpläne" vorgelegt bekommt, bei denen Strippen kreuz und quer ohne Zuordnung vernetzt wurden. Der erste Plan gehört sowieso auf den Zettel.

Bei mir ist der Ablauf meist so,

1) Zettel und Stift und die relevanten Strompfade zeichnen 2) Aufbau auf dem Breadboard 3) Einfachen Code zum Testen, ob das ganze machbar ist 4) Eagle Schaltplan mit allen Komponenten erstellen 5) Eagle PCB Layout entwerfen Danach mache ich mich an der Ausarbeitung des Programms, zeitglich erwarte ich dann 4 Wochen nach dem Layout idR meine Platinen aus China.

Claus_M: Ich wollte mal fragen ...

Fritzing benutze ich bislang nur in der Steckbrett-Ansicht. Sonst ist das IMO noch nicht sinnvoll nutzbar. Vielleicht ist das in jüngeren Systemen inzwischen anders (bei mir läuft Debian 7.9).

Zum Zeichnen/Planen von Schaltungen benutze ich gEDA. Man kann damit wohl auch Platinen entwerfen, aber das habe ich noch nicht gemacht.

Wenn Du mit Doku auch Texte meinst: Ich benutze Emacs als Editor für reine ASCII- bzw. Textdateien. Doxygen habe ich mir zwar mal angesehen, aber das erschien mir von der Handhabung her zu umständlich. Ich finde auch nicht, dass die „richtige“ Doku in C-Quelldateien stehen sollte. Ich finde, dass das die Dateien hässlich und schlecht lesbar macht.

Gruß

Gregor

Zettel und Stift ist das Erste und oft bleibt’s auch dabei. Wobei ich oft nur Fragmente zu Papier bringe, der Rest ist in meinem Kopf. Oft habe ich auf einem Schmierzettel Minischaltungen für nur einen I/O. Eine Treiberstufe, ein PWM zu 10V Konverter, der wiederum 10V Eingangsspannung braucht usw. So habe ich dann 3 oder 4 Zettelchen und u.U. gar kein komplettes Projekt.
Wenn etwas gut ist und nicht nur als Einzelanfertigung auf Lochraster aufgebaut wird, dann habe ich über den Leiterplattenentwurf von Eagle als “Nebenprdukt” auch einen sauberen Schaltplan :wink: