Projektdoku, welche Zeitform?

[Matzel]

In welcher Zeitform sollte die Projektdoku denn sein?

Ich habe da was von Präsens (Gegenwart) gelesen.

Unser Lehrer hat aber gesagt, das es sich ja um ein abgeschlossenes Projekt handelt, also auch in der Vergangenheit zu schreiben ist.

Wie sieht's denn jetzt aus???

Danke für die Antworten.

[Muadibb]

wahrscheinlich auch wieder von ihk zu ihk unterschiedlich.

ich denke aber das präsens oder perfekt die richtige wahl ist.

[McCaffrey]

Hi.

Dokumentationen werden in Präsens geschrieben!

mfg

McCaffrey

[gajUli]

Original geschrieben von Muadibb

wahrscheinlich auch wieder von ihk zu ihk unterschiedlich.

Ausnahmsweise nicht. Praesens gilt fuer Dokus in ganz Deutschland.

[Muadibb]

ok..dann habe ich ja glück gehabt, dass ich im präsens und nicht im perfekt geschrieben habe

aber ich habe viele passiv formen benutzt. ich hoffe, dass es kein so schlechter schreibstil ist.

[Crow T. Robot]

Hallo Matzel!

Original geschrieben von Matzel

In welcher Zeitform sollte die Projektdoku denn sein?

Ich habe da was von Präsens (Gegenwart) gelesen.

Unser Lehrer hat aber gesagt, das es sich ja um ein abgeschlossenes Projekt handelt, also auch in der Vergangenheit zu schreiben ist.

Ich kann mich meinen Vorrednern nur anschliessen: Präsens ist angesagt, ausserdem die Vermeidung der Ich-Form. Der Argumentation deines Lehrers kann ich absolut nicht folgen, denn schliesslich wird die Doku während der Projektdurchführung erstellt, das Projekt ist also mitnichten schon abgeschlossen.

[flying_mike]

also ich dachte immer, dokus werden Nach dem Projekt geschrieben.Wie soll ich denn zum Beispiel die Ist Analyse im Präsens schreiben??

"Bisher dient uns...." oder wie?

Versteh ich ned..

Kann man ned sonen gesunden Mischmasch nehmen?

Warum "Ich Form" vermeiden? Wenn "ICH" beschreibe was "ICH" gemacht habe???

:confused: bin verwirrrt

[Crow T. Robot]

Hallo flying_mike!

Die Erstellung der Doku begleitet den Projektablauf von Anfang bis zum Ende. Das Ergebnis jeder Projektphase wird sogleich dokumentiert. So sehe ich das.

Beispiel: Das Ergebnis des Fachkonzeptes wird in Form des Pflichtenhefts dokumentiert. Dies erstellst du logischerweise während bzw. am Ende dieser Phase, weil du sonst gar nicht weiterarbeiten kannst.

Wenn du dich nach der Durchführung noch daran erinnern kannst, was du dir alles am Anfang gedacht hast, kannst dir natürlich auch die Mühe machen, erst hinterher alles aufzuschreiben...

Natürlich wird nicht sofort alles voll ausformuliert, aber die Ergebnisse einer Phase sollte man zumindest in Stichworten, aber auf jeden Fall vollständig notieren.

Gerade die Ist-Analyse sollte beim Präsens kein Problem darstellen, schliesslich beschreibst du den momentanen Zustand des Projektumfeldes...

Beispiel: "Zur Zeit geschieht die Erfassung der erhobenen Daten händisch mit Papier und Bleistift."

Zur Ich-Form hat timm-bonn mal treffend geschrieben: "Die Ich-Form erinnert doch allzusehr an Aufsätze ala "mein schönstes Ferienerlebnis", die wir wohl alle in der 3.-4. Klasse schreiben durften. ;-)" Dem kann ich nichts hinzufügen...

[gajUli]

Das Argument, das Schreiben wuerde erst nach der Durchfuehrung geschehen, sticht nicht. Erstens muss das nicht so sein und zweitens gibt es eine ganze Menge Literaturgattungen im Praesens, die nach dem Beschriebenen verfasst werden.

[Matzel]

Danke Euch erstmal ganz herzlich für die schnellen Antworten.

Zum Glück habe ich alles im Präsens, glaube ich zumindest. ;-)

Habe halt sehr viel wird und werden drin. :-(

[McCaffrey]

Original geschrieben von flying_mike

also ich dachte immer, dokus werden Nach dem Projekt geschrieben.Wie soll ich denn zum Beispiel die Ist Analyse im Präsens schreiben??

"Bisher dient uns...." oder wie?

Um dein Grobkonzept zu erstellen musst du die Ist-Analyse abgeschlossen und damit auch schriftlich dokumentiert haben (oder führst du eine Ist-Analyse nur in deinem Kopf durch ).

Und dann wird auch die Ist-Analyse im Präsens geschrieben.

Beispiel:

"Zur Zeit wird ein Windows 2000 Server mit 25 Clients eingesetzt. Auf den Client Systemen ist Windows XX als Betriebssystem installiert"

mfg

McCaffrey

[BMAS]

Da ist es schon klar... der Zustand der bei der IST-Analyse aufgenommen wurde, besteht ja noch mindestens bis zur Übergabe des Projekts.

Aber wie streng wird darauf geachtet?

Bei Verwendeter Software, habe ich z.B. geschrieben, das die Anwendung mit dieser und dieser Software erstellt WIRD...

Also Zukunft.

Ausserdem habe ich bei der Planung geschrieben, dass Infos beim Ersteller der Datenbank eingeholt WURDEN, damit Entitäten implementiert werden KÖNNEN.

Geht sowas?

[sockä]

Ich habe auch im Präsens geschrieben, nur z.b. die übergabe habe ich in der vergangeheit geschrieben, denn wenn ich da hinschreibe "die übergabe erfolgt darin, dass blabla", dann könnte der schalue prüfer vielleicht denken, dass doe übergabe noch gar nciht stattgefunden hat. ich habe halt überall in der doku präsens, bis auf halt die Übergabe.

Man sollte auch immer im aktiv schreiben, so sätze wie "würden das gemacht haben" und "es wäre eine lösung" oder so klingen nicht gut. lieber schreiben, dass es so "ist" und so durchgeführt wird.

[gajUli]

Original geschrieben von BMAS

>Bei Verwendeter Software, habe ich z.B. geschrieben, das die Anwendung mit dieser und dieser Software erstellt WIRD...

Also Zukunft.

Guetiger Himmel, das ist ja zum Gotterbarmen!

"... Anwendung erstellt wird" ist Praesens Passiv.

Zukunft gibt es grammatisch als Futur I und Futur II:

"Anwendung wird erstellt werden" -> Futur I Passiv

"Anwendung wird erstellt worden sein" -> Futur II Passiv

Passiv soll man ja sowieso nicht unnoetig verwenden. Wie waer es mit:

"Bei der Erstellung der Anwendung kommt die Software So-und-so zum Einsatz." oder

"... ist die Software von Nutzen." oder

"... empfiehlt sich der Einsatz von..." oder

"... stellt die Software ein Core-Tool dar."

Alles uebrigens Praesens Aktiv

>Ausserdem habe ich bei der Planung geschrieben, dass Infos beim Ersteller der Datenbank eingeholt WURDEN, damit Entitäten implementiert werden KÖNNEN.

>Geht sowas?

Den Satz finde ich etwas ungluecklich, weil die zeitlichen Bezuege voellig verschwimmen. Vielleicht so: "Beim Ersteller der Datenbank eingeholte Informationen gestatten eine Implementierung weiterer Entitaeten." Die Frage ist auch, ob das einen Satz wert sein muss. Ist eigentlich klar, dass man eine Dokumentation fuer die Datenbank braucht, mit der man arbeitet.

[BMAS]

Wollte mit Zukunft eigentlich nur sagen, dass der zeitliche Bezug in der Zukunft liegt ... (Die Software wird während der Entwicklung mit der und der Software erstellt)

[BMAS]

Könntet ihr mir mal eine Aktivform von folgendem Satz bilden? Ich finde einfach keine gescheite!

Als nächstes wurde die Überlegung angestellt, welche Methoden der Client (bzw. die Business Logik des Clients) sowie der Server mindestens implementieren müssen. Diese Methoden wurden in Java-Interfaces definiert (siehe Anhang III), um den Programmcode besser strukturieren zu können.

[gajUli]

Original geschrieben von BMAS

>Könntet ihr mir mal eine Aktivform von folgendem Satz bilden?

Also ich seh da zwei Saetze.

>Als nächstes wurde die Überlegung angestellt,

Das ist Praeteritum und stilistisch "mein schoenstes Projekterlebnis", Klappe die Achthundertste.

>welche Methoden der Client (bzw. die Business Logik des Clients) sowie der Server mindestens implementieren müssen. Diese Methoden wurden in Java-Interfaces definiert (siehe Anhang III), um den Programmcode besser strukturieren zu können.

Was soll der zweite Satz an der Stelle? Er laesst den ersten unvollendet in der Luft haengen. Ausserdem halte ich ihn fachlich fuer nicht ganz koscher. Java-Interfaces sind doch viel mehr als ein Mittel der Codestrukturierung.

Ich wuerde da ganz anders herangehen, etwa so:

Fuer eine einwandfreie Funktion gemaess den Anforderungen ist eine klare Aufteilung der mindestens erforderlichen Methoden auf Client und Server unerlaesslich. Clientseitig sind zu implementieren:

1)...

2)...

3)...

...

Der Server stellt folgende Methoden bereit:

1)...

2)...

3)...

...

Es bietet sich die Verwendung von Java-Interfaces an, weil...

Wobei ich davon ausgehe, dass die gewaehlte Aufteilung an anderer Stelle genauer hergeleitet wird.

[BMAS]

Original geschrieben von gajUli

Also ich seh da zwei Saetze.

Das ist Praeteritum und stilistisch "mein schoenstes Projekterlebnis", Klappe die Achthundertste.

Ich dachte, dass das so geschrieben sein muss? Ich soll doch meine Entscheidungen darstellen.

Was soll der zweite Satz an der Stelle? Er laesst den ersten unvollendet in der Luft haengen. Ausserdem halte ich ihn fachlich fuer nicht ganz koscher. Java-Interfaces sind doch viel mehr als ein Mittel der Codestrukturierung.

Das schon, ich wollte den Leser aber eigentlich nicht mit einem Vortrag über Java Interfaces langweilen. Aber du hast recht, etwas mehr könnte ich da schon zu schreiben.

Fuer eine einwandfreie Funktion gemaess den Anforderungen ist eine klare Aufteilung der mindestens erforderlichen Methoden auf Client und Server unerlaesslich. Clientseitig sind zu implementieren:

1)...

2)...

3)...

...

Der Server stellt folgende Methoden bereit:

1)...

2)...

3)...

...

Es bietet sich die Verwendung von Java-Interfaces an, weil...

Klingt gut, werde ich so ähnlich machen. Danke!

Wobei ich davon ausgehe, dass die gewaehlte Aufteilung an anderer Stelle genauer hergeleitet wird.

Was meinst du damit?

[gajUli]

Original geschrieben von BMAS

>Ich dachte, dass das so geschrieben sein muss? Ich soll doch meine Entscheidungen darstellen.

Ja genau, aber in Dokumentationsform. Bei Deinem Beispiel war es vom Stil her zu sehr eine Erzaehlung.

>Das schon, ich wollte den Leser aber eigentlich nicht mit einem Vortrag über Java Interfaces langweilen. Aber du hast recht, etwas mehr könnte ich da schon zu schreiben.

Muss auch nicht sein. Kurze Darstellung, warum sich Java-Interfaces fuer den geplanten Zweck eignen, reicht.

>Was meinst du damit?

Dass Interfaces ja nicht vom Himmel fallen, sondern am Ende eines Entwurfsprozesses stehen.

[BMAS]

Hmm, ich habe geschrieben:

Ein weiterer Schritt der Strukturierung des Codes ist die Definition der Methoden, die von Client und Server mindestens implementiert werden müssen.

Hierfür bieten sich Java-Interfaces an, die zudem noch den Vorteil haben, nur Definitionen von Methoden zu enthalten, jedoch keinen Code. Das Schreiben des Codes erfolgt in den Klassen, die diese Interfaces implementieren.

Danach habe ich noch die Interfaces aufgezählt und ihren Verwendungszweck beschrieben, sowie auf den Anhang verwiesen (wo sich ihr Code befindet).

Meinst du das reicht?

[gajUli]

Ist von der Sprache her gut. Es fehlt aber die Begruendung der Verwendung der Interfaces. Wenn mich nicht alles taeuscht, kann man leere Funktionen auch in normalen Klassen scheiben und nach der Vererbung implementieren bzw. ueberschreiben.

[BMAS]

Ist von der Sprache her gut.

Na Gott sei Dank! Ich habe mich gestern den ganzen Tag (von 8:00 Uhr bis 23:00 Uhr) damit befasst meine Passivformen in Aktivformen abzuwandeln. Bin bei einigen Sätzen fast wahnsinnig geworden! Ich aber muss sagen, dass es sich gelohnt hat. Meine Doku liesst sich jetzt viel leichter.

Es fehlt aber die Begruendung der Verwendung der Interfaces. Wenn mich nicht alles taeuscht, kann man leere Funktionen auch in normalen Klassen scheiben und nach der Vererbung implementieren bzw. ueberschreiben.

Stimmt, du meinst abstrakte Klassen... sollte ich vielleicht auch noch rein tun.

Ich danke Dir!