Erklärung v. Fachbegr. in d. Doku?

[franky_phox]

Hallo Leute!

Ich bin soweit mit meiner Doku durch. Nun stellt sich mir die Frage, ob es sinnvoll bzw. möglich / erlaubt ist, als Anlage auch eine Erklärung der meisten verwendeten Fachbegriffe beizufügen. Oder denkt dann der Prüfungsausschuss, dass ich ihn für bescheuert halte?

Habt Ihr sowas vielleicht sogar auch schon gemacht?

Danke schonmal im Voraus!

Gruß,

Frank

[Danny De Vito]

Ciao,

erhalte es für sehr sinnvoll einen Glossar hinzuzufügen. Da die Doku ja auch quasi für einen Auftraggeber sein kann. Der PA bewertet dich danach wie du ein Projekt durchführst, und nur Sekundär die Inhalte. Ich selber hatte auch einen, wo ich so Sachen wie DHCP und Co drin hatte.

Ciao Vito

[franky_phox]

Hm, okay... Danke Dir. Ich denke, ich werde das dann auch machen.

[Matze134]

Original geschrieben von franky_phox

Hallo Leute!

Ich bin soweit mit meiner Doku durch. Nun stellt sich mir die Frage, ob es sinnvoll bzw. möglich / erlaubt ist, als Anlage auch eine Erklärung der meisten verwendeten Fachbegriffe beizufügen. Oder denkt dann der Prüfungsausschuss, dass ich ihn für bescheuert halte?

Habt Ihr sowas vielleicht sogar auch schon gemacht?

Danke schonmal im Voraus!

Gruß,

Frank

Ich würde das sogar als seblstverständlich halten! Denn stell dir mal den anderen Fall vor! Die Prüfer sitzen vor deiner Doku und verstehen die Doku nicht! Dann wird sie doch mit schlecht bewertet! So einen Anhang nicht zu machen wäre grob fahrlässig!

[themaster]

Ein andere Frage ist doch wie genau muss dieses Glossar werden?

Muß man (in meinem Fall) Begriffe der Objektorientiertung oder Java erklären? Oder darf man dass voraussetzen.

Oder reicht es wenn man J2EE oder Projektspezische Begriffe erklärt?

Wieviel Glossar muss sein?

P.S.:Mein Kunde kennt die Begriffe für den muss ich es nicht erklären nur für die Prüfer

[user103109]

Also ich mache auch ein Glossar, bei dem aber in erster Linie Fachbegriffe des Unternehmens erklärt werden. Diese können die Prüfer gar nicht verstehen.

Aber auch andere Begriffe aus der Projekt und IT Welt nehme ich mit ins Glossar.

So habe ich z.B. "DFÜ" und "Workflow" drin.

[P3AC3MAK3R]

Ein Glossar in der Projektdoku ist auf jeden Fall obligatorisch.

Allgemein bekannte Begriffe (HTML, PHP, SQL, ...) würde ich dort jedoch nicht erklären - eher betriebs- bzw. projektspezifische.

[CyberDemon]

In meinem Projekt ging es um Vitual Reality. Fachbegriffe wie Textur, Rendern, mappen und Polygone habe ich mit Fußnoten erklärt.

Ich hatte auch erst ein Glossar vor, aber mein Prüfer meinte mit Fußnoten kann man die Doku flüssiger lesen. Man muss nicht immer hinten im Anhang nach dem Begriff suchen.

Als Nachteil empfand ich persönlich, das bei max. 7 Fußnoten auf einer Seite der Platz ziemlich eng werden kann.

Aber wenn der Prüfer es so haben will.

[timmi-bonn]

Original geschrieben von franky_phox

Nun stellt sich mir die Frage, ob es sinnvoll bzw. möglich / erlaubt ist, als Anlage auch eine Erklärung der meisten verwendeten Fachbegriffe beizufügen. Oder denkt dann der Prüfungsausschuss, dass ich ihn für bescheuert halte?

In Bonn ist ein projektbezogenes Glossar sogar vorgeschrieben.

gruß, timmi