| Autor |
|
|
|
BID = 449244
Humus
Aus Forum ausgetreten
|
|
Servus,
ich möchte eine Projekt Dokumentation eines Aktuellen Projekts realisieren.
Was muss in eine Dokumentation alles rein, gibt es eventuelle strukturen die ratsam wären?
Das Projekt wurde noch nicht begonnen es besteht bis jetzt nur die Grundidee und genau deswegen möchte ich jetzt auch gleich anfangen eine Dokumentation dazu zu erstellen.
Vielleicht habt ihr auch den passenden link oder ein Beispiel parat, das wäre echt super! =)
Gruß
humus |
|
BID = 449255
Tobi P.
Schreibmaschine
Beiträge: 2168
Wohnort: 41464 Neuss
|
|
Da gibts verschiedene Möglichkeiten. Ich würde erst mal ein Pflichtenheft anlegen, in dem beschrieben wird, was verlangt wird, wie es realisiert werden soll, welche einschlägigen Vorschriften zu beachten sind etc.
Dazu kann man Gefährdungsanalysen erstellen, Stromlaufpläne, Verteilerpläne, Wartungslisten, Legenden und vieles andere mehr. Abschliessend dann die Protokolle der durchgeführten Prüfungen. Falls der Kunde es verlangt, liefere ich zur Dokumentation auch Grundrisspläne mit, in denen Kabeltrassen, Verteiler, Steckdosen etc. verzeichnet sind.
Vielleicht solltest du mal näher erklären, um was es genau geht. Dann können wir uns konkrete Lösungen einfallen lassen.
Gruß Tobi
_________________
"Auch wenn einige Unwissende etwas anderes behaupten, bin ich doch der Meinung, dass man nie genug Werkzeug haben kann" |
|
BID = 449256
Humus
Aus Forum ausgetreten
|
hey,
schon einmal danke für deine Antwort.
Es geht um ein Microcontroller Projekt.
|
BID = 449258
tsaphiel
Inventar
Beiträge: 3481
Wohnort: Unterfranken (frei statt Bayern!)
|  
Vergiss händische Lastenhefte und alles händische sowieso.
Informeier dich mal über Requirements Engineering!
Da gibts werkzeuge (bspw. Telelogic DOORS, Borland Caliber, ....) die dich bei sowas unterstützen. So hast du die Anforderungen gesammelt und ne Dokumentation fällt da nebenbei mit ab.
Das ganze Thema ist aber ne wissenschaft für sich - und nebenbei Bestandteil meiner Diplomarbeit! 
_________________
Druff un D'widd!!!
|
BID = 449263
Ltof
Inventar
Beiträge: 9334
Wohnort: Hommingberg
|
Zitat :
tsaphiel hat am 9 Aug 2007 19:20 geschrieben :
|
Vergiss händische Lastenhefte |
Genau!
Mach das intuitiv!  
Nee, mal im ernst: Wofür soll das Dokumentiert werden? Für einen Kunden, für eine Diplomarbeit, für Dich selbst oder was?
Gruß,
Ltof
_________________
„Schreibe nichts der Böswilligkeit zu, was durch Dummheit hinreichend erklärbar ist.“
(Hanlon’s Razor)
|
BID = 449273
Humus
Aus Forum ausgetreten
|
Das ganze mache ich eigentlich nur für mich selber, da ein kleines Projekt, aber damit möchte ich gleich das Dokumentieren und das schreiben einer Dokumentation üben, um einfach mal ein Gefühl dafür zubekommen!
|
BID = 449275
Steppenwolf
Schreibmaschine
Beiträge: 1757
Wohnort: Zürich, Schweiz
| 
Dann mach es grad noch mit LaTex ==> verdoppelt den Lerninhalt...
Lohnt sich, falls man sowas öfters machen muss und sieht gut aus.
http://de.wikipedia.org/wiki/LaTeX
Edit: Da fällt mir ein: Ich mache das ja auch  
Im Anhang ein Beispiel...
_________________
Meine Projekte:
http://mauerer.m.googlepages.com
[ Diese Nachricht wurde geändert von: Steppenwolf am 9 Aug 2007 20:31 ]
|
BID = 449279
Ltof
Inventar
Beiträge: 9334
Wohnort: Hommingberg
|
Ok!
Für ein µC-Projekt ist ein vernünftiger Schaltplan und ein vernünftig kommentierter Source-Code das wichtigste. Wichtig ist auch, dass, sowohl im Schaltplan, wie auch im Code, nicht offensichtliche "Absichten" extra kommentiert werden. Beispiel: früher wurden LEDs gerne mal als Referenzdioden missbraucht. Das kann ohne Kommentar im Schaltplan ziemlich schwachsinnig aussehen. Später wundert man sich: "Was habe ich mir dabei nur gedacht?!". Im Code gibt es vergleichbare Tricks, die man extra erklären sollte. Standardsachen aus dem "Schulbuch" erklären sich meist von selbst.
Beim Schreiben des Codes sollte die Hystorie der Versionen notiert werden. Z.B.: "Version 1.0: LED blinken funktioniert."; "Version 1.2: LED blinkt nicht mehr, dafür raucht der µC jetzt ab" oder so ähnlich. Und die verschiedenen Versionen auch aufheben. Die Fehlersuche wird damit einfacher.
Zum Schluß würde ich im Schaltplan oder einer übergeordneten Doku eintragen, welche Programmversion letztendlich verwendet wurde.
Prinzipiell versuche ich die Anzahl der Dokumente so gering wie möglich zu halten, ohne Informationen auszulassen.
Und: Heb' die Schmierzettel auf! Auch wenn keine Sau verstehen mag, was die zu bedeuten haben. Später wirst Du dankbar sein, wenn Du diese noch hast.
Gruß,
Ltof
_________________
„Schreibe nichts der Böswilligkeit zu, was durch Dummheit hinreichend erklärbar ist.“
(Hanlon’s Razor)
|
BID = 449354
clembra
Inventar
Beiträge: 5404
Wohnort: Weeze / Niederrhein
| 
Zitat :
Ltof hat am 9 Aug 2007 20:37 geschrieben :
|
OZ.B.: "Version 1.0: LED blinken funktioniert."; "Version 1.2: LED blinkt nicht mehr, dafür raucht der µC jetzt ab" oder so ähnlich.
|
Der ist gut 
Wenn man verschiedene Quelltextversionen und zufällig ein Unix-basiertes Betriebssystem hat kann ich subversion empfehlen (mit dem "Vorgänger" CVS habe ich nicht gearbeitet). Da hat man die Dokumentation der einzelnen Versionen automatisch.
Und den Quelltext gut kommentieren, kann man nicht oft genug sagen (so oft, wie ich mich schon über meine Programme geärgert habe )
Die Schmierzettel scanne ich meist nach Abschluss eines (Teil-)Projektes ein und speichere sie im Projektordner, ansonsten finde ich die nicht mehr wieder.
_________________
Reboot oder be root, das ist hier die Frage.
|
BID = 449358
DonComi
Inventar
Beiträge: 8605
Wohnort: Amerika
|
Wenn es nach den Schmierzetteln ginge, dann wären diverse Projektordner proppenvoll. Formelherleitungen, Schaltzskizzen und Bitmasken werden aber später nochmal ordentlich digitalisiert und dann mit in die Dokumentation gepackt.
Die eigentlichen Blätter werden dann entsorgt.
Datensätze und Diagramme werden mit OpenOffice Kalkulator berechnet/gezeichnet, Formeln im Formeleditor vorbereitet. Zuletzt werden dann alle als Objekte im OpenOffice Writer vereint und in den Text eingebettet. Dank Formatvorlagen ist das ruckzug fertig.
Sieht ziemlich professionell aus, auch wenn es sicherlich nicht allen Maßstäben gerecht wird. Aber dafür gibt es ja noch andere Programme.
_________________
A pro pro: hat wer eine Ahnung, wie ich Quelltexte mit Hervorhebung dort einbringen kann? Manuell will ich das nicht machen... So wichtig ist mir die Spielerei mit dem Syntax highlighting dann doch nicht...
Ausdrucken klapt aus vielen Programmen (ich arbeite mit Linux), auch Ausdrucke ins PDF. Darum geht es aber nicht.
[ Diese Nachricht wurde geändert von: DonComi am 10 Aug 2007 0:17 ]
|
