Dokumentationen erstellen

moses_rotesmeer · 25.09.2003, 21:11

Hallo Leute!

ich hab mich im internet ein bisschen umgeschaut um etwas über das erstellen von dokumentationen ( auf edv bezogen ) zu erfahren.

z.b. auf was es ankommt, was man beachten muss, villeicht vorlagen...

nur leider habe ich nichts gefunden... wer kann mir helfen?

Ich meine dokumentationen für edv also sprich z.b. dokumentationen für eine installation oder villeicht auch hardware bezogen (das einbauen von hardware oder so) ...

das wird von mir bei der lehrabschlussprüfung verlangt und naja, da man in der schule schon nichts lernt muss ich mich jetzt eben selber umschauen...

bitte um hilfe...

mfg moses

T.dot · 26.09.2003, 10:14

Sers!

Ich hab in meiner HTL Zeit einiges an Dokus erstellt und würd dir folgendes empfehlen:

Inhalt:
Ich hab zwar keine Ahnung, in welche Richtung deine Arbeit geht, aber egal: Ganz am Anfang eine Übersicht über die Arbeit - d.h. was war die Aufgabe, was kommt auf den Leser zu auf ca 1-2 Seiten. Damit dieser weiß, um was es geht und ob ers überhaupt liest.
Eine genauere Definition der Aufgabenstellung
Allgemeine Einführung in das Thema (die noch jeder versteht)
und falls es bei dir dann technisch wird, dann die technischen Details.
Das ganze immer möglichst so schreiben, dass es jeder versteht, der sich nicht mit dem Thema auseinander gesetzt hat. (Wie würdest du es deinen Eltern erklären, etc.)
Falls nötig am Ende auch ein Abkürzungs- und Quellenverzeichnis.

zur Formatierung:
Wenn die Arbeit gut ausschaut, braucht der Inhalt nicht mehr so gut sein und es kommt trotzdem halbwegs gut an. Wenn das ganze von der Formatierung von grund hinein bereits schlecht ist rettet dich der Inhalt auch nicht mehr wirklich.
D.h. Deckblatt, Inhaltsverzeichnis, gute Gliederung, Einheitliche Schriftart (zb Arial für technisches und kein Times New Roman), sinnvolle Kopf und Fußzeilen (mit Arbeitstitel, Seitennummer, etc.), einheitlichen Zeilenabstand, ...

Ich glaub wenn du das beherzigst schaut das ganze nicht so schlecht aus. Alles was ich bis jetzt vergessen habe und mir noch einfällt reiche ich nach

mfg T.

25.09.2003, 21:11	#1
moses_rotesmeer Veteran Registriert seit: 14.10.2000 Beiträge: 316	Dokumentationen erstellen Hallo Leute! ich hab mich im internet ein bisschen umgeschaut um etwas über das erstellen von dokumentationen ( auf edv bezogen ) zu erfahren. z.b. auf was es ankommt, was man beachten muss, villeicht vorlagen... nur leider habe ich nichts gefunden... wer kann mir helfen? Ich meine dokumentationen für edv also sprich z.b. dokumentationen für eine installation oder villeicht auch hardware bezogen (das einbauen von hardware oder so) ... das wird von mir bei der lehrabschlussprüfung verlangt und naja, da man in der schule schon nichts lernt muss ich mich jetzt eben selber umschauen... bitte um hilfe... mfg moses

26.09.2003, 10:14	#2
T.dot Master Registriert seit: 13.08.2003 Beiträge: 624	Sers! Ich hab in meiner HTL Zeit einiges an Dokus erstellt und würd dir folgendes empfehlen: Inhalt: Ich hab zwar keine Ahnung, in welche Richtung deine Arbeit geht, aber egal: Ganz am Anfang eine Übersicht über die Arbeit - d.h. was war die Aufgabe, was kommt auf den Leser zu auf ca 1-2 Seiten. Damit dieser weiß, um was es geht und ob ers überhaupt liest. Eine genauere Definition der Aufgabenstellung Allgemeine Einführung in das Thema (die noch jeder versteht) und falls es bei dir dann technisch wird, dann die technischen Details. Das ganze immer möglichst so schreiben, dass es jeder versteht, der sich nicht mit dem Thema auseinander gesetzt hat. (Wie würdest du es deinen Eltern erklären, etc.) Falls nötig am Ende auch ein Abkürzungs- und Quellenverzeichnis. zur Formatierung: Wenn die Arbeit gut ausschaut, braucht der Inhalt nicht mehr so gut sein und es kommt trotzdem halbwegs gut an. Wenn das ganze von der Formatierung von grund hinein bereits schlecht ist rettet dich der Inhalt auch nicht mehr wirklich. D.h. Deckblatt, Inhaltsverzeichnis, gute Gliederung, Einheitliche Schriftart (zb Arial für technisches und kein Times New Roman), sinnvolle Kopf und Fußzeilen (mit Arbeitstitel, Seitennummer, etc.), einheitlichen Zeilenabstand, ... Ich glaub wenn du das beherzigst schaut das ganze nicht so schlecht aus. Alles was ich bis jetzt vergessen habe und mir noch einfällt reiche ich nach mfg T.

Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Gäste: 1)