Schreibstil Dokumentation?

[fozzybaer]

Ich sitze gerade über meiner Dokumentation zu meiner Projektarbeit. Was ich schreiben muss, weiss ich einigermassen! Jetzt habe ich nur Fragen zum Schreibstil, da gehen die Meinungen ja auch etwas auseinander.

Gegenwart oder Vergangenheit?

Ich Form oder keine Ich-Form?

Ich gebe da mal ein paar Beispiele, was ist der korrekte Stil?

1. Ich habe ein Plichtenheft für die Programmierung ein Datenbank erstellt.

2. Ich erstelle ein Plichtenheft für die Programmierung einer Datenbank.

3. Es wurde ein Pflichtenheft für die Programmierung einer Datenbank erstellt.

4. Es wird ein Pflichtenheft für die Programmierung einer Datenbank erstellt.

Habe mir schon verschiedene Dokumetationen angesehen, und jede sieht diesbezüglich anders aus, manche sind vom Stil her sogar gemischt!!!:eek:

Da ich natürlich kein Interesse habe, wegen eines Schreibstils, der nicht optimal ist, Punkte zu verschenken (Wer hat das schon???), wäre es super, wenn mir jemand sagen könnte, was der perfekte Stil ist!!!

[Sandrin]

Ich habe damals meine Dokumentation in folgendem Stil erstellt:

"... Zur Aufbereitung der Setup-Daten muss die Datei xxx verändert werden. Von dieser Datei wird eine Kopie mit dem Namen des zu konfigurierenden RCAs erstellt. Die Ursprungsdatei wird nicht verändert, damit sie für weitere Konfigurationen zur Verfügung steht. ..."

Also Gegenwart und auf gar keinen Fall in der Ich-Form schreiben. Das wurde uns auch in der Schule eingebläut. Mein ehemaliger Ausbilder, der im Prüfungsausschuss sitzt vertritt die gleiche Meinung.

[timmi-bonn]

Originally posted by Sandrin

[...] Also Gegenwart und auf gar keinen Fall in der Ich-Form schreiben. Das wurde uns auch in der Schule eingebläut. Mein ehemaliger Ausbilder, der im Prüfungsausschuss sitzt vertritt die gleiche Meinung.

Ja, ich kenne diese These und auch etliche ihrer Verfechter. Ich selbst halte einen flüssigen (und damit lesbaren!) Schreibstil - egal in welcher Person oder Zeitstufe - für viel wichtiger. Daher weigere ich mich, Punkabzug für die Ich-Form oder für ein Imperfekt zu geben. Punktabzüge gibt es bei mir für die Form nur, wenn die Gliederungt völlig unsinnig ist oder wenn dauernde Fehler in Orthografie und/oder Grammatik zeigen, daß diese Doku ohne jegliche Sorgfalt (und damit Respekt!) hingeschmiert wurde. Ansonsten interessiert mich ausschließlich der Inhalt.

Aber andersrum: Bei einer inhaltlich schlechten Arbeit versuche ich gerne, "ein bis zwei Pluspunkte" bei Form und Stil rauszukitzeln. Ich finde, auch die Mühe und Sorgfalt, die in einer solchen Arbeit stecken, sollten Anerkennung (Punkte) finden.

gruß, timmi

[fozzybaer]

Originally posted by timmi-bonn

Ja, ich kenne diese These und auch etliche ihrer Verfechter. Ich selbst halte einen flüssigen (und damit lesbaren!) Schreibstil - egal in welcher Person oder Zeitstufe - für viel wichtiger. Daher weigere ich mich, Punkabzug für die Ich-Form oder für ein Imperfekt zu geben. Punktabzüge gibt es bei mir für die Form nur, wenn die Gliederungt völlig unsinnig ist oder wenn dauernde Fehler in Orthografie und/oder Grammatik zeigen, daß diese Doku ohne jegliche Sorgfalt (und damit Respekt!) hingeschmiert wurde. Ansonsten interessiert mich ausschließlich der Inhalt.

Aber andersrum: Bei einer inhaltlich schlechten Arbeit versuche ich gerne, "ein bis zwei Pluspunkte" bei Form und Stil rauszukitzeln. Ich finde, auch die Mühe und Sorgfalt, die in einer solchen Arbeit stecken, sollten Anerkennung (Punkte) finden.

gruß, timmi

Wenn ich wüsste, dass du meine Dokumentation korrigierst, wüsste ich jetzt, wie ich sie schreiben soll.

Aber wenn ich dich richtig verstehe, soll ich am besten in dem Stil schreiben, der mir am besten liegt? Im Prinzip könnt ich mit jedem Stil was anfangen.

Gibt´s da keine Erfahrungswerte?

Bin übrigens bei der IHK Augsburg, wenn dass evtl. weiterhilft!

[gajUli]

Originally posted by timmi-bonn

Ja, ich kenne diese These und auch etliche ihrer Verfechter. Ich selbst halte einen flüssigen (und damit lesbaren!) Schreibstil - egal in welcher Person oder Zeitstufe - für viel wichtiger. Daher weigere ich mich, Punkabzug für die Ich-Form oder für ein Imperfekt zu geben.

Darfst Du ja de jure machen. Richtig ist es trotzdem nicht.

"Egal in welcher Person oder Zeitstufe" bedeutet, man kann genau so gut fluessig schreiben, ohne die 1. Person Praeteritum zu benutzen. Also warum das dann? In erster Linie wohl, weil jemand nicht anders kann oder schlecht informiert ist. - Beides ist ein Abwertungsgrund, und zwar ein objektiver, auch wenn sich das vielleicht "fluessig" liest.

[fozzybaer]

Originally posted by gajUli

Darfst Du ja de jure machen. Richtig ist es trotzdem nicht.

"Egal in welcher Person oder Zeitstufe" bedeutet, man kann genau so gut fluessig schreiben, ohne die 1. Person Praeteritum zu benutzen. Also warum das dann? In erster Linie wohl, weil jemand nicht anders kann oder schlecht informiert ist. - Beides ist ein Abwertungsgrund, und zwar ein objektiver, auch wenn sich das vielleicht "fluessig" liest.

Das heisst auf gut Deusch Präsens und keine Ich-Form?

So langsam bin ich komplett verwirrt???:confused:

[gajUli]

Originally posted by fozzybaer

Das heisst auf gut Deusch Präsens und keine Ich-Form?

So langsam bin ich komplett verwirrt???:confused:

Hm, was treiben die bloss alle neuerdings im Deutsch-Unterricht...

Also wenn jemand z. B. schreibt (1. Person, Praeteritum): "Nach dem Aufstellen der Clients konfigurierte ich die Netzwerkeinstellungen des Schulungsraums. Dem Router wies ich die IP-Nummer 10.10.10.254 zu. Danach stellte ich die Subnetzmasken auf 255.255.255.0 ein und die IP-Adressen auf 10.10.10.1 bis 10.10.10.25."

Sprachlich ist das ein Mischmasch aus Bericht in Verlaufsform und Erzaehlung. Es ist autorbezogen und nicht leser- und sachbezogen. Es liest sich wie ein Schulaufsatz.

Eine Dokumentation ist etwas anderes. Im Mittelpunkt hat die Sache zu stehen, kurz und eindeutig, etwa so: "Die Clients sind mit folgenden Netzwerkeinstellungen konfiguriert: Router: 10.10.10.254, Subnetmask: 255.255.255.0, Clients: 10.10.10.1 bis 10.10.10.25."

Kann man auch als Liste oder Tabelle einfuegen. Schoen ergebnisbezogen. Der Leser freut sich...

[Sandrin]

@fozzybaer

Ich kann dir nur den Tipp geben dich an gajUli´s Aussagen zu halten, denn das ist der Schreibstil für Dokumentationen und den verlangen die meisten Prüfer. Außerdem ist es gar nicht so schwer in diesem Stil zu schreiben, wenn man sich einmal daran gewöhnt hat.

[fozzybaer]

Originally posted by gajUli

Hm, was treiben die bloss alle neuerdings im Deutsch-Unterricht...

Also wenn jemand z. B. schreibt (1. Person, Praeteritum): "Nach dem Aufstellen der Clients konfigurierte ich die Netzwerkeinstellungen des Schulungsraums. Dem Router wies ich die IP-Nummer 10.10.10.254 zu. Danach stellte ich die Subnetzmasken auf 255.255.255.0 ein und die IP-Adressen auf 10.10.10.1 bis 10.10.10.25."

Sprachlich ist das ein Mischmasch aus Bericht in Verlaufsform und Erzaehlung. Es ist autorbezogen und nicht leser- und sachbezogen. Es liest sich wie ein Schulaufsatz.

Eine Dokumentation ist etwas anderes. Im Mittelpunkt hat die Sache zu stehen, kurz und eindeutig, etwa so: "Die Clients sind mit folgenden Netzwerkeinstellungen konfiguriert: Router: 10.10.10.254, Subnetmask: 255.255.255.0, Clients: 10.10.10.1 bis 10.10.10.25."

Kann man auch als Liste oder Tabelle einfuegen. Schoen ergebnisbezogen. Der Leser freut sich...

Erst mal muss ich sagen, dass ich Umschüler bin und leider keinen Deutschunterricht habe bzw hatte. Einen Schulaufsatz wollt ich mit Sicherheit nicht schreiben, also werd ich das ganze sachbezogen schreiben!!!

Und die Sache mit den Tabellen ist auch nicht schlecht, da ich in meiner Doku ja eine Nutzwertanalyse machen muss.

Mein Projektthema lautet übrigens:

Erstellung eines Pflichtenhefts zur Teilnehmerverwaltung mit anschliessendem Angebotsvergleich.

Danke nochmal für den Tip!!!

Gruss

Tommy

[gajUli]

Originally posted by fozzybaer

Erst mal muss ich sagen, dass ich Umschüler bin und leider keinen Deutschunterricht habe bzw hatte.

Ich meinte das auch weniger auf Dich bezogen, sondern darauf, dass dieses Thema in mehr oder weniger abenteuerlichen Varianten immer wieder aufkommt.

[gajUli]

Ach ja, bevor ich es vergesse:

Originally posted by fozzybaer

1. Ich habe ein Plichtenheft für die Programmierung ein Datenbank erstellt.

2. Ich erstelle ein Plichtenheft für die Programmierung einer Datenbank.

3. Es wurde ein Pflichtenheft für die Programmierung einer Datenbank erstellt.

4. Es wird ein Pflichtenheft für die Programmierung einer Datenbank erstellt.

Wie waere es damit:

5. Gegenstand des Projektes ist die Erstellung eines Pflichtenheftes zur Programmierung einer Datenbank .

[Baumeister]

Kann mich nur wiederholen: Wer meine Doku will (88%), der sagt bescheid. Es geht um eine DSL Routeranbindung ans LAN. Bitte keine Postings von wegen: mir bitte auch und so. Wers will mailt an: bobderbaumeister@lallallgummiball.de

[fozzybaer]

Originally posted by gajUli

Ach ja, bevor ich es vergesse:

Wie waere es damit:

5. Gegenstand des Projektes ist die Erstellung eines Pflichtenheftes zur Programmierung einer Datenbank .

Hört sich gut an!!!

Danke für die guten Tips!!!

[Sandrin]

Kann mich nur wiederholen: Wer meine Doku will (88%), der sagt bescheid. Es geht um eine DSL Routeranbindung ans LAN. Bitte keine Postings von wegen: mir bitte auch und so. Wers will mailt an: bobderbaumeister@lallallgummiball.de

Sorry, aber ich würde niemandem eine Doku mit 88% als Vorlage empfehlen. Denn du hast wahrscheinlich ein paar Fehler gemacht und die würden sich dann bei jemandem der deine Doku als Vorlage nimmt vielleicht auch einschleichen.

[littleGina]

Hi,

also mit einer Vorlage für die Doku wäre ich ohnehin sehr vorsichtig.

Ich habe mir, bevor ich meine Doku geschrieben habe, einige Arbeiten auf bekannten Seiten angesehen. Die Dinger waren (angeblich) zum Teil mit einer Bewertung von über 90% versehen.

Ich kann da nur sagen, dass das wohl auch noch von Kammer zu Kammer verschieden ist.

Die IHK Köln legt beispielsweise allergrößten Wert auf die Prozessorientierung (und die war in fast keiner der "Vorlagen" gegeben). D.h. die wollen zwar verstehen, was Du gemacht hast, aber auch das WIE ist sehr wichtig. Entscheidungen, die Du getroffen hast sollen dargelegt, Alternativen aufgezeigt werden.

Aber wie gesagt, das ist wohl von Kammer zu Kammer unterschiedlich. Vielleicht kannst Du ja mal jemanden fragen, der im gleichen Kammerbezirk wie Du seine Prüfung abgelegt hat, oder einfach mal auf der Homepage Deiner Kammer nachsehen.

Zur Zeit, in der die Doku geschrieben werden sollte wurde uns gesagt, dass das nicht so wichtig sei. Die Hauptsache wäre, dass man EINE Zeit durchgängig braucht. Und das ganze solle sich gut lesen lassen (Tip: Leute, die nichts von Deinem Projekt wissen einfach mal lesen lassen und von denen erklären lassen, was Du gemacht hast.)

Viel Erfolg wünscht Dir

littleGina