1. Diese Seite verwendet Cookies. Wenn du dich weiterhin auf dieser Seite aufhältst, akzeptierst du unseren Einsatz von Cookies. Weitere Informationen

Aufbau einer Dokumentation

Dieses Thema im Forum "Kaffeeklatsch" wurde erstellt von Muckel1986, 24. März 2010.

  1. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Hallo zusammen,

    mir ist klar, dass dieses Thema nicht unbedingt in dieses Forum gehört, doch vielleicht hat die eine oder der andere doch eine Idee, Anmerkung oder Tipp für mich. Und zwar geht es um die Dokumentation meines Abschlussprojektes.

    Meine Ausbildung absolviere ich in einem Berufsbildungswerk. Wie auch die Kollegen die bei einem normalen Betrieb die Ausbildung machen, müssen wir als "Praktische Prüfung" ein Abschlussprojekt durchführen. Jenes muss dokumentiert werden. Die Dokumentation und eine spätere Präsentation sind die Grundlage der "benotung" für den praktischen Teil.

    Die für mich zuständige IHK hat keine Vorlage für den Aufbau dieser Dokumentation herraus gegeben und überlässt einen das somit selbst. Wir können uns zwar die Dokumentationen unserer Vorgänger anschauen, doch da gibt es nur zwei, an denen ich mich grob orientieren könnte, da die anderen nicht gut sind. Und bei einer der beiden muss ich einen Abstand zu halten, da ich dieses Abschlussprojekt fortführe und es sich daher nicht ähneln sollte. Unter Itse-Guide.de habe ich ein paar Informationen gefunden, wie auch bei den Wikipedia-Artikeln zum Lasten- und Pflichtenheft.

    Selbst habe ich mir einen Aufbau / Struktur auch überlegt:

    • Titelseite
    • Inhaltsverzeichnis
    • Planung
      • Kundengespräch
      • Beschaffung der Materialien
      • Umgebungsbedingungen
        • Räumlichkeiten
        • Beleuchtung
        • Temperatur
        • Verschmutzung
        • besondere Unfallgefahren
    • IST-Analyse und SOLL-Konzept
      • IST-Analye
        • vorhandene Hardware
        • vorhandene Software
      • SOLL-Konzept
        • geplante Hardware
        • geplante Software
    • Durchführung
      • Beschreibung der einzelnen Arbeitsschritte
    • Fazit
    • Anhang
      • Glossar / Stichwortverzeichnis
      • Quellenverzeichnis
    Aber irgendwie sagt mir das noch nicht so ganz zu. Hoffe daher, dass ihr vielleicht Tipps, Ideen oder ähnliches habt, wie man den Strukturellen Aufbau noch machen könnte.

    Liebe Grüße
    Muckel/Tobias
     
  2. KayC

    KayC Stehauffrauchen

    Registriert seit:
    14. Juni 2003
    Beiträge:
    1.160
    Zustimmungen:
    1
    Hast du denn von der Schule keine Informationen? Hast du mal bei den Fachinformatikern-Systemintegration geschaut? Die sind ja mit euch "berufsmäßig verwandt": http://www.fachinformatiker.de/.

    lg, Katharina
     
  3. luke

    luke HYLO-VFKQHJJHULVFK

    Registriert seit:
    28. August 2009
    Beiträge:
    352
    Zustimmungen:
    0
    Ort:
    evil-hausen
    hallo muckel,

    so grob (erste ebene):
    titel
    grundlagen
    analyse
    design
    implementierung
    fallbeispiel
    bewertung

    dazu noch inhaltsverzeichnis, abbildungsverzeichnis, quellen ....

    vielleicht hast du zeit dich mal mit latex zu beschäftigen.

    gruß

    luke
     
  4. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Hallo zusammen,

    Informationen haben wir so direkt nicht bekommen. Die Informationen der Berufsschule belaufen sich nur darauf, dass die Dokumentation 10 Seiten stark sein soll. Hinzu kommt dann noch die Erklärungen im Glossar, sprich die tatsächliche Länge könnte länger sein als die 10 Seiten.

    Doch zum/vom Aufbauher haben wir da keine Infos erhalten. Mein "Betrieb" ist eben ein Berufsbildungswerk. Leider ist in jenem das Niveau nicht unbedingt gut. Wir haben zwar die Dokus unserer Vorgänger, doch als Beispiel welches man nehmen könnte, gibt es nur zwei oder drei, da die anderen einfach zu schlecht sind. Und von diesen guten ist eine eben die, von dem Abschlussprojekt, welches ich weiterführe; aus diesem Grund kann ich mich an jene nicht unbedingt orientieren.

    Ja, LaTeX ist mir bekannt, doch wie ich die Doku später umsetzte, ist ja relativ egal. Im Regelfall wird hier im "Betrieb" eben OpenOffice eingesetzt und dies reich im Grunde auch vollkommen aus, da mit auch damit Funktionen wie Inhaltsverzeichnis, Fuß- und Endnoten nutzen kann. Auch Kopf- und Fußzeilen und die gesamte Formatierung kann man damit ja ohne Probleme einfügen.

    Von der Formatierung her habe ich mich was die Seitenränder betrifft an die Vorgaben der DIN 5008 bzw. 676 gehalten, welche zwar eigentlich für einen Brief gedacht sind, doch so kann ich sicher gehen, dass auch die Ausgabe der Doku in ein Umschlag passt usw.

    Am Ende soll die Doku eh in drei Varianten zur IHK:

    1. gebundene Ausgabe
    2. Blattsammlung
    3. PDF-Dokument gebrannt auf CD-Rom
    Doch es geht mir halt um den Inhaltlichen Aufbau, die Struktur und genau für jene haben wir keine Vorgaben/Vorlagen bekommen.

    Vielen Dank und liebe Grüße
    Muckel/Tobias
     
  5. tevahe

    tevahe Neues Mitglied

    Registriert seit:
    3. Dezember 2007
    Beiträge:
    258
    Zustimmungen:
    0
    Ort:
    Bei Goslar die Ecke (Seesen)
    Im Zweifelsfall entscheidet weniger was auf den Folien steht oder wie du sie angeordnet hast, als mehr das Layout und der Geschmack, der Person, welche es sich anschaut.

    Ich hatte mal einen, der Stand auf die Farbe Grün und bei einem anderen hatte man ein Stein im Brett wenn irgendwo ein Pokemon auftauchte. :D

    Rein von der Struktur her würde ich daran nicht viel verändern, wobei ich verstehe das dich etwas stört, es geht mir ebenso, aber ich wüsste nicht genau was...

    Das Quellenverzeichnis aber zb., ich persönlich hätte das nicht gern hinter der Präsentation...
    Ist das in irgendeiner Weise vorgegeben?

    Und was das Stichwortverzeichnis angeht, offiziell gehört es meines Erachtens nach zu der Präsentation, da es ja Begrifflichkeiten nochmal erklärt und vorallem deswegen nicht dahinter gehöen sollte.

    Ich weiß nicht was dir dazu gesagt wurde, aber die zwei Punkte würden mich schon stören.

    Versteh es bitte nicht falsch, aber die Präsi sollte spätestens mit dem Fazit zuende sein und nicht das am Ende nochmal Sachen erklärt werden, die man bei der Vorführung selber schon nicht verstanden hat.

    Weißt du wie?
     
  6. chamaeleon

    chamaeleon farbenfroh

    Registriert seit:
    17. März 2010
    Beiträge:
    9
    Zustimmungen:
    0
    Ort:
    Baltimore
    hallo,
    ich finde die struktur in ordnung -- weiss ja nicht genau worum es genau geht in deinem projekt.
    vorschlag: die grundstruktur ist IMMER: einleitung, hauptteil, fazit.
    da die planung zum hauptteil gehoert wuerde ich hinter dem inhaltsverzeichnis eine einleitung einfuehren mit dem inhalt: was du machen willst, wie die arbeit aufgebaut ist und welche quellen du verwendest. vor allem gehoert auch in die einleitung warum du das projekt machen willst: was ist der stand der dinge? hat schon jemand vorher versucht so etwas zu machen und ist gescheitert? was interessiert dich daran? wird dadurch etwas weiterentwickelt?

    beim anhang: literatur- und quellenverzeichnis muss vor das glossar.

    ich kann dir noch einen vorschlag machen: ich arbeite an der uni und kann relativ schnell korrektur lesen. falls du jemanden brauchst, der das ganze schnell durchschaut und ueberliest, dann schick mir eine pn. ich habe fuer so etwas immer etwas zeit und so ein projekt ist einfach eine grosse herausforderung und man macht automatisch tippfehler und man uebersieht eigene fehler.
    sag' mir ggf. einfach vorher bescheid wann du den text oder bestimmte textteile fertig hast. dann koennte ich das einplanen.

    liebe gruesse,
    chamaeleon
     
  7. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Guten Abend zusammen,

    die ersten zwei Abschluss-Projekt Tage waren ganz okai - bis auf das das Löten heute ziemlich auf die Hände ging, doch jene kann ich ja nun am Wochenende ausruhen um ab Montag die letzten drei Tage durch zu stehen.

    Tevahe muss ich im Grunde recht geben - von meinem "Gefühl" her hätte ich das Stichwortverzeichnis und die Quellenangaben mit in den Hauptteil genommen. Doch das ist neben der "es sollen ca 10 Seiten + Anhang sein" Regelung das einzige, was uns als "Vorgabe" genannt wurde.

    Die Dokumentation unterscheidet sich auch nochmal von der Präsentation (die muss ich ja gesondert erstellen, nach dem Projekt). Wichtig in der Doku ist vorallem, dass meine Arbeitsschritte dokumentiert sind und das die Entscheidungsfindung nachvollziehbar ist. Denn ganz gleich ob man ein Projekt auch zu Ende führen kann oder wie bei dem "Vorgänger Projekt" zu meinem nicht, so lange alles ordnungsgemäß dokumentiert und nachvollziehbar ist (wie bei dem Garantiefall des Vorgänger-Projektes), ist es für den Prüfungsausschuss wohl in Ordnung.

    Normalerweise würde ich bei den "Begrifferklärungen" zum Beispiel mit Fuß- oder Endnoten arbeiten, doch dies sollen wir nicht machen, da es keine "Wiessenschaftliche Arbeit" sein soll.

    Vielen Dank für dein Angebot mit dem Korrektur lesen, werde mich mit Dir in Verbindung setzten. Die "Einleitung" ergibt sich bei uns durch das Kundengespräch und den Arbeitsplan, den man sich auf Grund des Kundengespräches überlegt. Danach folgt die Materialbeschaffung und überprüfung und dann folgen die Arbeitsschritte. Meine "Struktur" schaut im Moment so aus:

    • Titelseite (Logo des Arbeitsgebers, Titel des Projektes, mein Name, Datum des Projektes, evtl. Foto der "Veränderung")
    • Auftrag
    • Planung
      • Kundengespräch
      • Umgebungsbedingungen
      • Verwendetes Material
        • Materialbeschaffung
        • Materialüberprüfung
    • IST-Analyse und SOLL-Konzept
      • vorhandene Hardware
      • vorhandene Software
      • geplante Hardware
      • geplante Software
      • Übersicht der "Verkabelung" der CNC- / DNC-Maschinen
        • IST-Zustand
        • SOLL-Zustand
    • Durchführung
      • Einrichten des neuen Computer
      • Prüfen der vorhandenen Leitungen und deren Belegung
        • Prüfung der bereits verlegten PATCH-Leitung
        • Belegungsfindung der vorhandenen seriellen Datenleitung
        • Überprüfung der vorhandenen Adapter
      • Herstellung der benötigten Adapter
      • Aufbau und Montage der Komponenten
        • Anbau des Schutzgehäuses für den Seriel-zu-Ethernet-Umsetzer
        • Aufbau des neuen PCs
        • Verbindung zwischen PC und dem Adapter herstellen
        • Testen dieser Verbindung mit Hilfe eines Laptops
        • Anschluss einer CNC- / DNC-Maschine und versuch eine Verbindung herzustellen. Bei Erfolg evtl. Ausgabe eines Werkstückes.
      • Weiterverwendung der spezial Tastatur
      • demontage der nicht mehr verwendeten Umschaltboxen
    • Fazit
    • Anhang
      • Literatur- und Quellenverzeichnis
      • Glossar / Stichwortverzeichnis
      • Testprotokolle
      • Screenshots
      • Bilder
    Was nun noch folgen muss sind die weiteren Arbeiten durch zu führen und jene zu beschreiben. Ergänzt durch ein paar Fotos, Screenshots und Messprotokolle.

    Hoffe sehr, dass mein Körper sich am Wochenende ein wenig erholen kann und ich alles in den letzten drei Tagen schaffen werde.

    Vielen Dank für eure Tipps und Hinweise!
    Liebe Grüße
    Muckel/Tobias
     
  8. chamaeleon

    chamaeleon farbenfroh

    Registriert seit:
    17. März 2010
    Beiträge:
    9
    Zustimmungen:
    0
    Ort:
    Baltimore
    hey, erhol' dich gut am wochenende.
    du schaffst das!
    viele gruesse,
    chamaeleon
     
  9. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Guten Morgen,

    dank des Gewitters war die Nacht nicht gerade die beste, aber ich habe ausgeschlafen und daher wird es schon irgendwie klappen. Gerade suche ich nach einer Möglichkeit, wie ich bei einem Gerät entweder die Werkseinstellungen wieder herstellen kann oder das Passwort zurücksetzten kann. Problem ist, dass der Kollege der das vor einem Jahr eingerichtet hat, nicht mehr da ist (ausgelernt) und mein Ausbilder weiß nicht mehr, welches Passwort sie genutzt haben. Und die Konfigurationsmöglichkeit über den Webbrowser würde ich schon gerne nutzen, doch dazu brauche ich entweder das Passwort oder muss es zurück setzten... Naja, mal schauen ob ich dazu noch was finde.

    Wünsch euch ein schönes Wochenende!
    Liebe Grüße
    Muckel/Tobias
     
  10. luke

    luke HYLO-VFKQHJJHULVFK

    Registriert seit:
    28. August 2009
    Beiträge:
    352
    Zustimmungen:
    0
    Ort:
    evil-hausen
  11. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Guten Abend,

    danke für den Link. Doch in der Doku zu unserem Prdoukt, steht der Bereich nicht drin, bei Dir schon - vielleicht klappt es ja trotzde, das werde ich morgen sehen. Habe außerdem der Firma 'ne Mail geschrieben und hoffe, dass sie antworten werden - mal schauen.

    Da Gerät funktioniert ja und lässt sich über die Software auch konfigurieren, nur bei dem Passwort für die Webschnittstelle hapert es.

    Vielen Dank
    Muckel/Tobias
     
  12. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Hallo luke

    konnte dies heute endlich testen und es funktioniert. Komisch ist halt nur, dass es in den PDFs die bei dem Gerät dabei waren, nicht drinne stand, obwohl die PDFs den gleichen Dateinamen haben. Aber egal - es hat klappt und ich konnte die Verbindung zwischen dem neuen PC, dem serial-zu-ethernet-Umsetzer und meinem ArbeitsPC herstellen.

    Morgen werde ich das ganze in der Metallausbildung testen und sofern es klappt, eine CNC- / DNC-Maschine über den Adapter ansprechen. Dann bleibt noch ein Problem übrig, an das ich mich wenden muss.

    Liebe Grüße
    Muckel/Tobias
     
  13. luke

    luke HYLO-VFKQHJJHULVFK

    Registriert seit:
    28. August 2009
    Beiträge:
    352
    Zustimmungen:
    0
    Ort:
    evil-hausen
    hallo Muckel1986,

    egal hauptsache es funktioniert.
    wünsche dir viel erfolg.

    gruß

    luke
     
  14. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Hallo zusammen,

    ja - da hast Du recht, luke. Aber die Firma/der Hersteller hatte gestern auch via E-Mail geantwortet, wie man das Gerät notfalls zurücksetzten würde. Aber das hat sich nun ja zum Glück erledigt.

    Der Aufbau meiner Situation schaut im Moment so aus:

    • Titelseite
    • Inhaltsverzeichnis
    • Hinweis Gesundheitliche Situation
    • Auftrag
    • Planung
      • Kundengespräch
      • Umgebungsbedingungen
      • Arbeitsplan
      • Verwendetes Material
        • Beschaffung des Material
        • Überprüfung des Material
    • IST-Zustand und SOLL-Konzept
      • Vorhandene Hardware
      • Vorhandene Software
      • Geplante Hardware
      • Geplante Software
      • Übersicht der „Verkabelung“
        • IST-Zustand
        • SOLL-Zustand
    • Durchführung
      • Einrichten des neuen Computer
      • Prüfen der vorhandenen Leitungen
        • Prüfen der vorhandenen seriellen Datenleitung und überprüfen dessen Belegung, da die Leitung einen Wechsel von 9 poligen zu 25 poligen Stecker hat
        • Überprüfung der vorhandenen PATCH-Leitung
        • Überprüfung der vorhandenen Adapter
      • Herstellung der benötigten Adapter
      • Aufbau und Montage der Komponenten
      • Weiterverwendung der Spezial-Tastatur
      • Abschluss des Projektes und Einweisung des Kunden
    • Fazit
    • Anhang
      • Bilder
        • Arbeitsplatz Metallbereich (Vorher und Nacher)
        • Umschaltboxen
        • neuer Computer
        • Spezial-Tastatur und dazugehörige ISA-Steckkarte
        • Screenshots
          • Kommunikation über die COM-Schnittstelle
          • LAVA-Link Software für den „“
          • TNCremo
      • Protokoll des Netzwerktestes
      • Schreiben des Arztes wegen dem Gesundheitlichen Zustand
      • Stichwortverzeichnis / Glossar
      • Quellenverzeichnis
    Mein Ausbilder findet es so in Ordnung, ich selbst bin mir da noch nicht so sicher. Der Hinweis auf meine Gesundheit ist leider notwendig, da ich mir bei einigen Sachen helfen lassen musste (Anbau des Schutzgehäuses; vorallem das Löcher bohren in die Beton-Wand) und dies muss halt begründet sein. Damit es dabei keine Probleme gibt, habe ich mir zusätzlich ein paar Zeilen meines Rheumatologen und meiner Schmerztherapeutin schreiben lassen.

    Hoffe das nach der Mittagspause die Verbindung zwischen PC und CNC- / DNC-Maschine klappt. Denn ich habe nur noch die zweite Helfte von heute und den morgigen Arbeitstag.

    Bin bislang aber guter Dinge, dass dies alles klappt.

    Liebe Grüße und vielen Dank für eure Hilfe
    Muckel / Tobias
     
  15. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Guten Abend zusammen,

    danke nochmal für eure Hilfe! Wer das Ergebnis sehen möchte, kann sich die PDF-Datei downloaden. Denn in meinem Blog kann ich es erst nach der Präsentation am 15.6. online stellen - da die Prüfer teilweise nach den Dokus googlen und würden sie es im www finden, müsste man sich erklären und beweisen, dass man alles selbst erstellt hat. Daher zur Zeit nur diese Variante.

    Als nächstes muss ich daraus noch eine Präsentation erstellen. Wäre auch da für Tipps nochmal dankbar, da ich nur die Groben-Tipps kenne, wie zum Beispiel

    • pro Folie wenig Punkte mit kurzen Sätzen
    • auf die lesbarkeit achten
      • Schriftart die nicht zu klein ist
      • Kontraste / Farben berücksichtigen
    • auf die Reihenfolge der Folien achten, damit sie übereinstimmt mit dem, was man erzählen möchte
    Denke das es da noch mehr gibt, da mein Notebook zur Zeit aber zickt, kann ich wohl erst ab Mittwoch aktiver suchen.

    Liebe Grüße
    Muckel/Tobias
     
  16. luke

    luke HYLO-VFKQHJJHULVFK

    Registriert seit:
    28. August 2009
    Beiträge:
    352
    Zustimmungen:
    0
    Ort:
    evil-hausen
  17. Muckel1986

    Muckel1986 Neues Mitglied

    Registriert seit:
    3. April 2006
    Beiträge:
    829
    Zustimmungen:
    0
    Ort:
    Braunschweig
    Moin luke,

    das wäre eine Möglichkeit, doch da ich eh vom V-Server zu 'nem Hostingangebot wechsle und somit umziehe, brauche ich das zur Zeit nicht. Und der upload der PDF war hauptsächlich nur da, damit ich jene noch auf Rechtschreibfehler korrekturlesen lassen konnte.

    LG
    Muckel