Mal wieder: Zeitform in Doku?

[.::NotesUser::.]

Hallo zusammen,

ich weiß ja, dass eine Doku im Präsens geschrieben werden soll. Aber ich kann mir das nicht so gut vorstellen.

Ein Beispiel:

Neben der Routine "Anmeldung löschen" ist auch die Aktion "Anmeldung abschicken" eigefügt, in welcher eine e-Mail generiert wird.

Es klingt doch viel besser:

Neben der Routine "Anmeldung löshcen" WURDE auch die Aktion ...

Es soll ja der Verlauf daargestellt werden. Dies klapt mit der Vergangenheit viel leichter.

[Gast Saesh]

wird?

[Borges]

Original geschrieben von .::NotesUser::.

Hallo zusammen,

ich weiß ja, dass eine Doku im Präsens geschrieben werden soll. Aber ich kann mir das nicht so gut vorstellen.

Wer sagt das? Es geht hier um die Dokumentation eines abgeschlossenen konkreten Projektes, nicht um eine Benutzerdokumentation oder ähnliches. Wie kann man im Präsens eine abgeschlossene Handlung reflektieren?

Gruß,

Borges

[Gast Saesh]

Hi Borges,

es ist wohl eher eine Vorgangsbeschreibung. Die kann man z.B. als Beispiel in der "wird"-Form schreiben.

Hier wird das und das eingesetzt, etc. weil bla....

[.::NotesUser::.]

Ja gut... hier wird das und das gemacht weil.

Aber diese Aktion WURDE erstellt um dies zu realisieren.

Und nicht diese Aktion WIRD erstellt um dies zu realisieren.

[Borges]

Die Reflektion war nur ein Beispiel. Ein Anderes: Die strikte Verwendung des Präsens wirkt IMHO lächerlich, wenn im Projektverlauf ein unvorhergesehenes Ereignis eintritt, das dann zu einer Änderung der ursprünglichen Konzeption führt. Das passierte nun einmal in der Vergangenheit.

Ich will damit nur sagen, dass pauschale Aussagen blödsinnig sind :-)

Gruß,

Borges

[Gast Saesh]

Original geschrieben von .::NotesUser::.

Aber diese Aktion WURDE erstellt um dies zu realisieren.

Und nicht diese Aktion WIRD erstellt um dies zu realisieren.

Das ist grammatikalisch beides richtig. Aber als Notes User muss man sowas nicht wissen

[.::NotesUser::.]

hey... nix gegen notes....

ähm... klar is des beides grammatikalisch richtig.

Aber des letztere macht für mich keinen verlauf eines projektes deutlich. Sondern eher eine Begründung. Das dies gemacht wurde, weil...

Klingt verdammt nach Benutzerhandbuch oder so. Eben nicht nach einem Verlauf.

[gajUli]

Hier sind mal wieder einige einem verbreiteten Motivirrtum aufgesessen. Es geht nicht darum, den Verlauf des Projekts als Erzaehlung zu verfassen (dann naemlich waere Praeteritum eine richtige Zeitform).

Betrachten wir das Beispiel von Notesuser:

>Neben der Routine "Anmeldung löschen" ist auch die Aktion "Anmeldung abschicken" eigefügt, in welcher eine e-Mail generiert wird.

>Es klingt doch viel besser:

Neben der Routine "Anmeldung löshcen" WURDE auch die Aktion ...

Nein, das klingt keineswegs besser, sondern unbeholfen und geradezu peinlich unreif.

Der Satz enthaelt so oder so nur drei Information:

1) Es gibt eine Routine "Anmeldung loeschen"

2) Es gibt eine Aktion "Anmeldung abschicken"

3) Die Aktion unter 2) bedingt das Generieren einer email

Was also ist hier wesentlich? - Die Eigenschaften einer Software. Der Hauptsatz lautet aber: "Die Aktion ist eingefuegt." Er benennt eine vollstaendig ueberfluessige weil redundante Aussage, denn es ist ja klar, dass sie eingefuegt worden sein muss, weil sie sonst eben nicht dort waere. Als ob das noch nicht schlimm genug waere, bezieht die Passiv-Form den Sinn wieder auf die Software zurueck. Merkt ihr, wie grauenvoll das sprachlich eigentlich ist?

Der Nebensatz geraet wesentlich besser: "Eine e-Mail wird generiert." Stoerend allerdings auch hier das Passiv.

Fragt Euch doch einfach, in welchem Sinnzusammenhang die Punkte 1-3 stehen. Dann formuliert sich das fast von allein ohne Tempi-Kontroversen. Beispielsweise koennte der Satz so lauten (Ich weiss natuerlich nicht die genauen Zusammenhaenge):

Das Menue "Anmeldung" stellt die Funktionen "Editieren", "Loeschen" und "Abschicken" bereit. Das Abschicken einer Anmeldung fuehrt unmittelbar zur Erzeugung einer e-Mail, die den Empfang quittiert.

Ich finde, das hoert sich ueberhaupt nicht merkwuerdig an.

Also bitte, beschreibt einfach die Dinge in ihrem natuerlichen Zusammenhang und Zweck, aber lasst die ewigen Erzaehltendenzen raus. Dieses dauernde "Zuerst wurde, dann haben wir, spaeter musste noch, zwischendurch ergab sich allerdings..." vermurkst Euch sonst nicht nur die Sprache, sondern auch das Denken, das ist linguistisch erwiesen.

[Borges]

Original geschrieben von gajUli

Hier sind mal wieder einige einem verbreiteten Motivirrtum aufgesessen. Es geht nicht darum, den Verlauf des Projekts als Erzaehlung zu verfassen (dann naemlich waere Praeteritum eine richtige Zeitform).

Ich bin auch manchmal entsetzt von Dokumentationen, die sich stilistisch wie der Aufsatz "Mein schönster Ferientag" lesen. Insofern vollkommener Konsens. Aber trotzdem erkenne ich aus der Zielsetzung der Projektdokumentation nicht, warum die Vergangenheitsform strikt vermieden werden soll.

Schauen wir einmal in die Umsetzungshilfen des BMBF (http://www.bmbf.de/pub/it-abschlussbericht.pdf)

6.1 Projektarbeit und Dokumentation

Durch die Projektarbeit und deren Dokumentation soll der Prüfungsteilnehmer

belegen, dass er Arbeitsabläufe und Teilaufgaben zielorientiert unter Beachtung

wirtschaftlicher, technischer, organisatorischer und zeitlicher Vorgaben selbstständig

planen und kundengerecht umsetzen sowie Dokumentationen kundengerecht

anfertigen, zusammenstellen und modifizieren kann.

Die Ausführung der Projektarbeit wird mit praxisbezogenen Unterlagen dokumentiert.

Der Prüfungsausschuss bewertet die Projektarbeit anhand der Dokumentation. Dabei

wird nicht das Ergebnis - z. B. ein lauffähiges Programm - herangezogen, sondern

der Arbeitsprozess. Die Dokumentation ist keine wissenschaftliche Abhandlung,

sondern eine handlungsorientierte Darstellung des Projektablaufs mit

praxisbezogenen, d.h. betriebüblichen Unterlagen.

Inhalt der Dokumentation sind:

• Name und Ausbildungsberuf des Prüfungsteilnehmers

• Angabe des Ausbildungsbetriebes

• Thema der Projektarbeit

• Falls erforderlich, Beschreibung/Konkretisierung des Auftrages

• Umfassende Beschreibung der Prozessschritte und der erzielten Ergebnisse

• Gegebenenfalls Veränderungen zum Projektantrag mit Begründung

• Wenn für das Projekt erforderlich, ein Anhang mit praxisbezogenen Unterlagen

und Dokumenten. Dieser Anhang sollte nicht aufgebläht werden. Die angehängten

Dokumente und Unterlagen sind auf das absolute Minimum zu

beschränken.

Eine handlungsorientierte Darstellung (dieser Begriff wird auch von unserer IHK in ihren Handreichungen genutzt) ist keine reine technische Dokumentation, keine Benutzerdokumentation oder ähnliches. Präsens dahin, wo es hingehört. Bei der Beschreibung von Programmfunktionen wie im Ausgangsbeispiel sicher. Bei den kundenbezogenen Dokumenten im Anhang auch.

Aber die Projektdokumentation ist viel mehr. Was ist, wenn durch externe Ereignisse Änderungen im Projektablauf notwendig geworden sind. Wenn Tests ergeben haben, dass eine Funktion nicht den Wünschen des Auftraggebers entsprochen hat und daraufhin Änderungen erfolgten? Das muss doch alles dort hinein (handlungsorientiert!). Ein völliger Verzicht auf die Vergangenheitsform ergibt für mich nur dann Sinn, wenn die Dokumentation in Form eines Projekttagebuchs erfolgt.

Die Beispieldokumentationen in den Umsetzungshilfen des BMBF scheinen meine Auffassung da zu unterstützen. Und ich habe den Eindruck, dass unsere Prüfungsausschüsse (Duisburg) das auch pragmatisch sehen. Die ärgert eher ein Blödsinn wie "Soll-Analyse".

Übrigens gilt ähnliches für die strikte Vermeidung der "Ich"-Form mit analogen Argumenten. Ich habe dazu auch schon die Aussage gehört, dass eine zu neutrale Schreibweise manchmal nicht erkennen lässt, wo die Fremdleistungen in einem Projekt aufhören und die Eigenleistung (oder auch Handlung) anfängt.

Gruß,

Borges

[gajUli]

Original geschrieben von Borges

>Ich bin auch manchmal entsetzt von Dokumentationen, die sich stilistisch wie der Aufsatz "Mein schönster Ferientag" lesen. Insofern vollkommener Konsens. Aber trotzdem erkenne ich aus der Zielsetzung der Projektdokumentation nicht, warum die Vergangenheitsform strikt vermieden werden soll.

Daraus allein ist es auch nicht abzuleiten. Es folgt vielmehr aus allgemeinen sprachlichen Normen.

>Schauen wir einmal in die Umsetzungshilfen des BMBF

Lieber nicht...

>Und ich habe den Eindruck, dass unsere Prüfungsausschüsse (Duisburg) das auch pragmatisch sehen. Die ärgert eher ein Blödsinn wie "Soll-Analyse".

Mich auch. Mein privates Unwort des Jahres 1999. Sehr witzig auch "Ist-Zustand". Ich meine, ein Zustand IST ja auf jeden Fall, sonst waere es ja kein Zustand, gelle? ;-)

>Übrigens gilt ähnliches für die strikte Vermeidung der "Ich"-Form mit analogen Argumenten. Ich habe dazu auch schon die Aussage gehört, dass eine zu neutrale Schreibweise manchmal nicht erkennen lässt, wo die Fremdleistungen in einem Projekt aufhören und die Eigenleistung (oder auch Handlung) anfängt.

Minderbemittelte Geister moegen das so sehen.

Die Dokumentation hat

a) die 1. Person Singular zu vermeiden

eindeutig zwischen Eigenanteilen und Fremdanteilen zu diffenrenzieren

Man kann durchaus beides leisten.

[nextgen]

hi,

ich bin auch gerade an meiner doku. und zwar beim punkt

Testphase

da schreibe ich unter Testergebnisse z.b.

Bei der Tests stellte sich heraus dass vor blabla dies und jenes geschehen sollte, diese wurde mit der JavaScript Funktion xyz umgesetzt.

wie sollte ich sowas in die gegenwartsform bringen!?

Der Test ergibt, dass vor blabla dies und jenes geschehen sollte, dies wird mit der Funktion xyz umgesetzt.

ich finde das ist irgendwie nicht so passend? oder doch?

danke schonmal

[nextgen]

mist, jetzt kann ich nichtmehr editieren.

was ich noch dazufügen wollte.

beim Fazit oder Soll-/ist vergleich ergeben sich ebenfalls lücken.

ich kann ja schlecht schreiben

Während der Projektdurchführung ergeben sich folgende Abweichungen vom Projektantrag

...tabelle mit änderungen....

oder doch?

[timmi-bonn]

[...] Testphase

da schreibe ich unter Testergebnisse z.b.

Bei der Tests stellte sich heraus dass vor blabla dies und jenes geschehen sollte, diese wurde mit der JavaScript Funktion xyz umgesetzt.

wie sollte ich sowas in die gegenwartsform bringen!? [...]

Das Praesens ist bei Dir gar nicht das Haupt-Problem: Du testest falsch!

Ein sauberer Test laeuft anhand eines Testkonzeptes ab. Zentrales Arbeitsmittel ist die darin enthaltene Testmatrix. Nach dieser wird gegen alle denkbaren Fehler getestet. ...Nicht auf Funktionieren. Du kannst als Ergebnis nur getestete Fehler (in einem definierten Umfeld) ausschliessen - niemals, dass alles immer und in jeder Umgebung fehlerfrei laeuft.

Btw., hast Du gemerkt: Das geht ganz hervorragend im Praesens.

gruss, timmi

[nextgen]

Das Praesens ist bei Dir gar nicht das Haupt-Problem: Du testest falsch!

Ein sauberer Test laeuft anhand eines Testkonzeptes ab. Zentrales Arbeitsmittel ist die darin enthaltene Testmatrix. Nach dieser wird gegen alle denkbaren Fehler getestet. ...Nicht auf Funktionieren. Du kannst als Ergebnis nur getestete Fehler (in einem definierten Umfeld) ausschliessen - niemals, dass alles immer und in jeder Umgebung fehlerfrei laeuft.

Btw., hast Du gemerkt: Das geht ganz hervorragend im Praesens.

ich kann dir nicht so ganz folgen.

mit dem testen habe ich sowieso so meine probleme.

ich teste doch die funktionalität und stoße dabei evtl. auf fehler, oder?

aja, zur zeitform nochmal. ich hab hier eine beispieldouku von meiner ihk. abgesehen von der ich-form die dort verwendet wird, nutzen die darin auch am anfang präsens und sobald es um die durchführung geht die vergangenheitsform.

nextgen

[Umbratus]

ich teste doch die funktionalität und stoße dabei evtl. auf fehler, oder?

Und was wenn du Fehler "zufällig" nicht findest, sondern diese erst beim Anwender deiner Software auffallen ??

Testen immer auf NICHT-Funktion.

Deine Funktionen sollen optimalerweise immer das richtige Ergebnis liefern und nicht nur im "Idealfall".

[timmi-bonn]

ich teste doch die funktionalität und stoße dabei evtl. auf fehler, oder?

Nein, eben nicht!

Du untersuchst, welche Fehler alle denkbar sind. Diese möglichen Fehler listest Du am besten in einer sogenannten Test-Matrix auf. Und dann testest Du der Reihe nach auf alle diese Fehler - und hoffst, dass sie nicht auftreten. Zur Optimierung aller dieser Fehlerfaelle gibt es durchaus Ansaetze fuer objektorientiertes Testen. Aber da nach meiner Erfahrung das Testen selbst eh schon meist recht unzulänglich vermittelt wird (Betrieb und Schule), bin ich schon immer dankbar, wenn ein Prüfling überhaupt verstanden hat, wie grundsätzlich getestet wird - und nicht den Einschalttest mit einem vollständigen Testkonzept verwechselt.

Garantieren kannst Du immer nur, dass ein bestimmter (getesteter) Fehler nicht auftritt. Fehlerfreies Funktionieren kannst Du nicht garantieren.

gruss, timmi

[nextgen]

ok, danke. ich hab das jetzt etwas umgeschrieben.

aber in zwischen wechsle ich zwischen den zeitformen. je nachdem ob ich ein reelles ergebnis betrachte (im nachhinein) oder ob ich einen ablauf beschreibe (allgemein/gegenwart).

viel zeit ist jetzt nichtmehr bis zur abgabe und ich muss noch ein benutzerhandbuch erstellen.

nextgen

[Umbratus]

aber in zwischen wechsle ich zwischen den zeitformen.

Das ist imho die schlechteste aller Lösungen.

[nextgen]

naja, ich hab leider keine ahnung wie ich in der gegenwart z.b. schreiben soll dass sich während der durchführung des projektes abweichungen zum projektantrag ergeben haben. und das ist nur eins von vielen bsp.

wos geht, bei allgemeinen punkten, oder auch noch dem fazit ist präsens ok. vielleicht hab ich ja auch den komplett falschen aufbau in meiner doku, und das ist der grund warum die zeitform nicht dazu passt.

nextgen

[TalRasha]

So tut mir leid das ich mal so ein alten Thread ausgrabe

Wollte nur wissen welche Zeit Form ihr in dem Punkt Projektdurchführung gewählt habt. Ich schreibe im Moment immer: Das wird gewählt weil ...

oder soll man schreiben: das wurde gewählt weil...

??

[Chief Wiggum]

Schau mal bei Uli unter dem Punkt Projektdokumentation nach.

http://caesborn.de/pruefungspage/index.html

[TalRasha]

als ist wird und wurde komplett falsch.

Wird für mich verdammt schwer das jetzt noch in so einer hochnäßigen Sprache umzuschreiben "Zum Einsatz kommt das Programm x, weil..."

Man kann ja nicht immer schreiben "Zum Einsatz kommt..."

Passt das denn wenn ich schreibe: "Gewählt wurde das Programm weil" ???

[allesweg]

als ist wird und wurde komplett falsch.

[snip]

Passt das denn wenn ich schreibe: "Gewählt wurde das Programm weil" ???

*starken Kaffee dazustell*

[TalRasha]

Bitte eine vernüftige Antwort, bin sprachlich nicht sonderlich gut..