Sprachstil in der Doku

[laila]

Hallo allerseits,

ich bin neu angemeldet. Wollte mal fragen wie ihr des so haltet mit dem Sprachstil in der Doku. Ich mein damit ob man persönlich also "ich habe das und das getan" schreibt oder unpersönlich also "es wurde das und das getan".

Wär ganz nett wenn ich da von euch ein paar Meinungen hören könntet. Ich mach bei der IHK Nürnberg Prüfung als FIAE.

Grüße,

Laila

[ingh]

Hallo und Willkommen

Schau dich mal auf Uli's Prüfungspage um, da gibts auch eine Seite zur Projektdoku.

[laila]

Hallo und Willkommen

Schau dich mal auf Uli's Prüfungspage um, da gibts auch eine Seite zur Projektdoku.

Hi,

danke für deinen Tip. Die obige Seite ist echt gut und hat viele Tips. Bin nur leider ganz hin und her gerissen, weil ein Prüfer zu mir gemeint hat ich soll in der Ich-Form schreiben und alle die ich sonst frage meinen ich soll unpersönlich schreiben was mir auch besser gefallen würde... Was soll ich jetzt machen???

Grüße,

Laila

[P4tr!ck]

Hi,

danke für deinen Tip. Die obige Seite ist echt gut und hat viele Tips. Bin nur leider ganz hin und her gerissen, weil ein Prüfer zu mir gemeint hat ich soll in der Ich-Form schreiben und alle die ich sonst frage meinen ich soll unpersönlich schreiben was mir auch besser gefallen würde... Was soll ich jetzt machen???

Grüße,

Laila

Wenn dein Prüfer das sogar ausdrücklich gesagt hat, dann würde ich mich auch daran halten.

[ingh]

Bin nur leider ganz hin und her gerissen, weil ein Prüfer zu mir gemeint hat ich soll in der Ich-Form schreiben [...]

"irgendein" Prüfer, oder tatsächlich jemand, bei dem deine Doku zur Bewertung auf dem Schreibtisch landen könnte?

Schau auch mal in diesen Thread.

[allesweg]

... weil ein Prüfer zu mir gemeint hat ich soll in der Ich-Form schreiben...

1.: "Dein" Prüfer?

2.: Gesagt oder geschrieben?

[bndr]

Hallo zusammen,

ich habe auch noch eine Frage und dachte mir ich schließe mich hier kurz an. Wenn ich einen (Last)test durchgeführt habe, in welchem Sprachstil dokumentiere ich die Durchführung?

Der Test wurde gestartet, der Lüfter fiel aus....

Der Test startet, der Lüfter fällt nach einiger Zeit aus...

Der Test startete....

(Das sind nur Beispiele, ich kann besser formulieren als ich es hier zugebe )

Habt ihr da Tips?

[charmanta]

( Unmittelbar ? ) Nach Start des Tests fiel ( bereits ? ) einer der Lüfter aus. Dieser Umstand wirkte sich ( nicht ) auf das Testszenario aus, da die Restkühlleistung reichte ( nicht reichte ) .....

Schön sachlich bleiben und immer daran denken, daß durch die Beschreibung eines Testszenarions Punkte für den Bereich Qualitätssicherung gegeben werden ... oder eben nicht

[bndr]

Mir war an und für sich nur unklar ob ich in der Vergangenheitsform schreiben darf

Hätte ich deutlicher schreiben müssen!

Vielen Dank für deine Hilfe!

Chris

[laila]

Erst einmal danke an ingh und allesweg, dass ihr geantwortet habt.

Um auf eure Fragen zurück zu kommen. Mir hat ein Prüfer der IHK Nürnberg gesagt ich soll in der Ich-Form schreiben, ob er mein Prüfer ist hat er mir natürlich nicht gesagt, weiß ich also nicht...

Ich mach einen Vorbereitungskurs für Projektdokumentation bei diesem Prüfer.

[allesweg]

Schriftlich dokumentieren lassen, am besten mit IHK-Stempel

*ungläubig gugg*

[timmi-bonn]

Mir hat ein Prüfer der IHK Nürnberg gesagt ich soll in der Ich-Form schreiben, ob er mein Prüfer ist hat er mir natürlich nicht gesagt, weiß ich also nicht...

Nun, mit Prüfern ist es, wie im richtigen Leben : Viele beherrschen zwar ihr Fachgebiet, sind im Deutschen aber nicht unbedingt sattelfest.

Eine Dokumentation ist eine Dokumentation - und kein Erlebnisaufsatz in der Art "Mein schönstes Netzwerk-Erlebnis".

gruss, timmi

[Neo_Guevara]

Kleiner Auszug einer Doku ( in diesem Stil werde ich meine Doku verfassen)

Die Funktion doReadM2d () erhält als Übergabeparameter das in convertMetaTree() erzeugte drawingObj. Von diesem wird zunächst der Maßstab ermittelt und anschliessend die Variablen, die zur Erstellung des IGES-Files notwendig sind nochmal auf Fehlerfreiheit überprüft. Ist diese gewährleistet, wird die Ausgabedatei erzeugt.

Zur Abarbeitung des drawingObj werden die Klassen m2dHandler, m2dDrawingHandler und m2dFigureHandler herangezogen, die von den entsprechenden Basisklassen der CADENAS-API abgeleitet wurden. Diese Klassen erben Funktionen, mit denen sie das drawingObj durchlaufen können. Diese Abarbeitung funktioniert bei jeder Schnittstelle nach dem selben Prinzip. Die entsprechenden Aktionen für den Export (in Datei schreiben bzw. mit CAD-System kommunizieren) werden in diesen Klassen in der Methode execute festgelegt.