Hallo, Mal eine Frage an die Berufsentwickler unter uns... Ich fertige gerade für ein Projekt von mir eine kleine Dokumentation an. In dieser möchte ich eine Schaltung beschreiben. Da fällt mir auf, daß dies gar nicht so einfach ist eine leicht verständliche, gut aussehende Schaltungsbeschreibung ohne Ballast anzufertigen. Und da es in Deutschland ja für alles einer Richtlinie gibt wollte ich fragen ob es für Beschreibungen elektrischer Schaltvorgänge ebenfalls eine Art Richtlinie oder ein bestimmtes Vokabular gibt? Oder schreibt jeder Entwickler so wie ihm gerade der Stift gewachsen ist? Zwar ist das ja nur eine Hobbydukumentation die ich da anfertige, doch interessiert es mich halt und warum soll sich eine Hobbydokumentation nicht auch gut anhören? Leider habe ich dazu bei Google und Wikipedia nichts gefunden oder einfach nur nach den falschen Begriffen gesucht. Also dann bin ich mal gespannt wie ein Flitzebogen :)
Ist mir nichts bekannt. Ich denke, am besten bekommt man das in den Griff, in dem man ein dutzend fremder Schaltungsbeschreibungen gelesen hat, z.B. in Applikation-Notes oder in Fachzeitschriften. Daraus kann man dann seine eigenen Richtlinien extrahieren. Und immer dran denken: Bei einem Text muss sich immer einer Mühe geben, der Schreiber oder der Leser. Besser, der Schreiber macht es. Ist gesamtheitlich effizienter.
Guck mal hier: http://www.google.de/search?hl=de&q=DIN+EN+62079&btnG=Google-Suche&meta=lr%3Dlang_de Arno
Hauptsächlich musst Du Dir wohl Gedanken machen, für wen Du schreibst. Für einen Anfänger, Hobbyist oder für einen Profi? Selbst dann kann man, wenn man geschickt genug ist, auch die Türen für die "Neben-Zielgruppe" noch aufhalten. Und ganz wichtig für deutsche Autoren: Immer an den Leser denken, und nicht mit der Sprache versuchen anzugeben. Genau das ist auch der Grund, warum amerikanische Fachliteratur so ein Genuß ist, und Deutsche Fachliteratur meistens ziemlich daneben greift.
Ah ja, das werde ich mir mal genauer ansehen. Danke schonmal für die Tips und Hinweise...
@Unbekannter: Naja ich denke ich schreibe für Leute wie ich und du. Also für Bastler mit allgemeinen technischen Kenntnissen und der Lust sich in unbekanntes Terrirorium hineinzuarbeiten. Also gehe ich schon davon aus, daß der Leser genügend Wissen besitzt um zu erkennen was die Schaltung macht. Doch möchte ich eben der Vollständigkeit halber noch in kurzen Sätzen die grundlegende Funktion der Schaltung anreißen. Na mal sehen, ich schreibe erstmal den Rest zuende.
Hallo André, genau vor solchen Fragen stand ich auch schon einige Male. Ich habe dann versucht mich in die Zielgruppe zu versetzen. Ist auch nicht einfach, aber hilft schon ein Stück weiter. Ich habe mir inzwischen angewöhnt so zu schreiben wie ich mich über dasjeweilige Projekt auch mit den Zielpersonen unterhalten würde. Im Hobbybereich also recht locker-flockig (und mit gelegentlich "eigener Rechtschreibung") und im Job möglichst seriös (versuche ich zumindest ;-)) Das Ganze noch halbwegs strukturiert und gut is. Auf meiner Seite (-> google) kannst du ja einiges lesen.... ;-) Guido
Hallo André,
es gibt zwar keine Norm, man könnte sich aber an den Aufbau (nach
googlen!) einer FMEA halten, was in Deinem Fall aber ziemlich
blödsinnig ist, denn Du hast das Teil ja (nehme ich an) allein und
nicht im Team entwickelt.
Wenn Du es dennoch etwas professionell machen willst, muß die
Beschreibung strukturiert sein. Etwa so:
>Meine Entwicklung<
1. Gesamtfunktionsbeschreibung der Baugruppe (was tut das Teil
insgesamt, wozu ist es gut, Beispiel: Fuse-Destroyer ;))))))
2. Wenn ein Netzteil integriert ist, beginne von der 230V Seite her die
Funktion des N-Teils zu beschreiben. Z.B. "Die Versorgespannung von
+12V wird über den Regler IC1 7812 stabilisiert.....etc etc"
3. Beschreibe dann weiter vom Eingang her wenn vorhanden), und teile
die Schaltung in Funktionsgruppen auf. Beschreibe den Signalweg, was wo
warum gemacht wird. Also z.B. Vorverstärker, Mischer, Integrator,
Synchrondemodulator....-> Ausgang. Wenn ein Prozessor vorhanden ist,
beginne mit dessen Funktion und beschreibe dann alles drumherum.
Wenn Software drin(drauf) läuft kann man dann noch die
Softwarefunktionen anhängen, hier auch wieder strukturieren, denn
schließlich willst Du ja auch noch nach 3 Jahren der Beschreibung
entnehmen wollen, was da drin läuft ;)
Viel Erfolg
Peter
@Guido:
>Auf meiner Seite (-> google) kannst du ja einiges lesen.... ;-)
Was Google ist deine Seite? ;)
Da war ich übrings drauf, wie du den Stylus repariert hast ist schon ne
witzige Angelegenheit, so macht es doch der wahre Bastler :)
@Peter
Grundsätzlich versuche ich mich eben beim Aufbau der Dokumentation eher
am Bastler zu orientieren. Daher habe ich viele Bilder und hoffentlich
übersichtliche Tabellen drinne, statt seitenweise
Schaltungsbeschreibung. Wo ich ganz Konkret drüber gestolpert bin ist
die kurze Beschreibung einer kleinen Schaltung in meinem aktuellen
Projekt. Da stellt sich dann eben die Frage ob ein (Schalt-)Transistor
niederohmig wird oder durchschaltet und ob eine Z-Diode eine Spannung
erst ab 3,6V durchläßt oder ob sie erst ab 3,6V leitend wird.
Da dachte ich eben das es vielleicht ein Standard in der Ausdrucksweise
von elektrischen Schaltvorgängen gibt.
Wenn du was fertig hast, stell es doch einfach mal Online und wir könnten hier Feedback geben, wie es sich liest. Dadurch kann man meist eine Menge lernen.
Na klar, ich bin gerade bei der Softwarebeschreibung (also fast am Ende) :)
@ André Ist schon klar, viele detailreiche Fotos sind für Hobbyisten immer am besten, eine kurze Schaltungsbeschreibung aber spätestens dann wichtig, wenn es an die Fehlersuche geht, denn Du kannst nicht davon ausgehen daß jeder die Funktionsweise nur durch einen Blick auf das Schaltbild versteht. Aber das ist vor allem auch eine Frage der Komplexizität. Wenn da ein Transistor in der Schaltung ist, erübrigt sich meist eine ausführliche Beschreibung, wenn es aber komplexe Funktionen sind, dann ist eine Beschreibung immer für denjenigen nützlich, der ohne Teilfunktionen nie erkennen würde. Nützlich sind dann auch eingetragene Oszillogramme usw.. Zu den konkreten Fragen: Ein Schalttransistor macht das was der Name sagt, nämlich schalten, er schaltet also auf Masse oder +Ub (beispielsweise). Wohingegen eine Zenerdiode eine (über einen Widerstand) angelegte Spannung auf den Zenerwert BEGRENZT, will sagen, es wird immer ein (sehr) kleiner Strom auch dann durch die Diode fließen, wenn die angelegte Spannung unterhalt der Zenerspannung liegt. Wenn man das näher erklären möchte, hilft die grafische Darstellung des Stromflusses abhängig von der angelegten Spannung. Bei der Zenerspannung ist ein deutlicher Knick erkennbar ;) Peter
@Andrè
> Was Google ist deine Seite? ;)
klar, ist aber auch nur Stress. Laufend will mir jemand meine Millionen
anlegen (möglichst auf sein Konto) ;-)))
Der Stylus war übrigens ein echter Schnellschuss, hält aber mindestens
bis zu nächsten Papstwahl.
Guido
So jetzt ist die Dokumentation fertig... ich werde jedoch nochmal die anderen Texte (auf die da verwiesen wird) nachbearbeiten. Also wenn jemand einen Tip hat was man noch besser machen kann, dann einfach sagen :)
Werd mir das die Tage mal näher anschaunen, auf jeden Fall hast du dir ja eine Menge Mühe bei gegeben, war bestimmt viel Fleißarbeit. Es gibt zu wenig Menschen, die Dokumentationen schreiben, insofern solltest du dein Talent in diese Richtung fördern.
Naja für das Projekt habe ca. eine Woche gebraucht. Wobei ich es auch langsam angegangen bin. Ich habe ja Zeit. Für die Dokumentation habe ich ca. 6 Tage gebraucht. Also nahezu genauso lange wie für das Projekt selbt. Aber auch hier habe ich mir Zeit gelassen und lieber ein nicht zufriedenstellendes Foto oder Bild nochmal neu gemacht. Auch wenn es immer wieder Überwindung gekostet hat nicht einfach was neues zu machen sondern erstmal dieses Projekt 100% abzuschließen (samt Dokumentation) bin ich jetzt sehr glücklich darüber. Durch die Dokumentation habe ich übrings noch einen Fehler in der Software gefunden und wurde gezwungen mich mit vielen Teiles des Projektes nocheinmal genau zu befassen. Also habe ich selbst durch die Dokumentation das Projekt nochmal verinnerlicht. Übrings waren die Kachelmuster nicht eingeplant. Ursprünglich hatte ich als Muster die "wilden" Steifen im Anfangsbild, aber keine geordneten Kacheln. Erst als die Dokumentation an der Stelle angekommen war kam ich auf die Idee noch ein Kachelmuster einzuarbeiten... war witzig und es sieht viel besser aus als ein paar "wilde" Streifen ;)
Durchzuhalten und etwas zu Ende zu bringen, anstatt gleich wieder sich einen neuen Kick zu holen durch ein neues Projekt, finde ich wertvoll. So entstehen dann wirklich brauchbare Dinge, anstatt nur jede Menge Unfertiges.
Hallo André, SUPER Deine Doku! Besser kann man es nicht machen! Mich würde das ganze auch vom Inhalt her interessieren, schick mir doch kurz mal eine email offboard krengeldatec@gmx.de, vielleicht kann man ja was zusammen machen? Gruß Peter
Danke für die Blumen, ich möchte auch irgendwann mal wieder eine Homepage machen und da kommt natürlich auch alles rauf :) @Winfried: Durchhltevermögen ist in der Tat extrem wichtig. Es bringt nichts wenn man die besten Ideen hat und sie aber nie wirklich bis zum Ende verwirktlicht. Daher finde ich es extrem wichtig bei großen Projekten (MP3 Player etc.) dieses immer in kleine Unterprojekte zu teilen und Stück für Stück voran zu gehen. (Top-Down-Entwurf)
Thread beobachten
Seitenaufteilung abschaltenBitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.