Begriffeerklärung in der Doku ?

[CyberDemon]

Hallo.

Mein Abschlußprojekt zum FI / AE findet im Bereich Virtual Reality statt.

Hier gibt es eine Menge Fachbegriffe wie: rendern, Polygone, TextureMapping, etc.

Soll ich nun in der Doku solche Begriffe erläutern? Falls ja, wie? Mit Fußnoten, als Anhang oder ganz anders? Ich könnte sie zwar umschreiben, aber es heißt ja auch "kompilieren" und nicht "inmaschinenspracheübersetzen".

Bin für jeden guten Ratschlag dankbar!

[timmi-bonn]

Originally posted by CyberDemon

[...]

Hier gibt es eine Menge Fachbegriffe wie: rendern, Polygone, TextureMapping, etc.

Soll ich nun in der Doku solche Begriffe erläutern? Falls ja, wie? Mit Fußnoten, als Anhang oder ganz anders? [...]

Das gehört in das sog. projektbezogene "Glossar"; und dieses wiederum in den Anhang. Elegant wäre es, im Text darauf hinzuweisen, wenn immer ein Begriff im Glossar erklärt wird. Das kann man mit Fußnoten machen; eleganter finde ich allerdings kursiv oder unterstrichen. Das unterbricht den Lesefluß nicht gar so sehr. ...Aber das ist letzendlich wohl Geschmacksache (...sprach der Affe - und biß in die Seife).

gruß, timmi

[CyberDemon]

Elegant wäre es, im Text darauf hinzuweisen, wenn immer ein Begriff im Glossar erklärt wird.

Dann hätte ich aber sehr viele "siehe Glossar" in der Doku stehen.

Könnte ich auch am Anfang der Doku zum Beispiel schreiben: Kursive Texte bitte im Glossar nachschauen. oder so ähnlich

[timmi-bonn]

Originally posted by CyberDemon

Dann hätte ich aber sehr viele "siehe Glossar" in der Doku stehen.

Könnte ich auch am Anfang der Doku zum Beispiel schreiben: Kursive Texte bitte im Glossar nachschauen. oder so ähnlich

Genau so meinte ich das: Kursiv gedruckte Wörter sind im Glossar ausführlich erklärt. ... Eben UM die dauernden Fußnoten zu vermeiden.

gruß, timmi

[Blue55]

Original geschrieben von timmi-bonn

Kursiv gedruckte Wörter sind im Glossar ausführlich erklärt.

Ähm, find ich gut, aber an welcher Stelle der Doku würdest du diesen Satz einfügen? Wenn ich so drüber nachdenke, würde mir der Satz in meiner Doku irgendwie ziemlich verloren vorkommen.

[Der Kleine]

Original geschrieben von Blue55

Ähm, find ich gut, aber an welcher Stelle der Doku würdest du diesen Satz einfügen? Wenn ich so drüber nachdenke, würde mir der Satz in meiner Doku irgendwie ziemlich verloren vorkommen.

Vielleicht vor dem fachlichen Teil nach der Einführung in die Aufgabenstellung (bzw. der Vorsetllung des Unternehmens) oder auch eventuell als Fußnote auf der ersten Seite.

[Chipmunky]

Also ich habe das direkt unter das Inhaltsverzeichnis gesetzt, habe ich in mehreren Beispiel-Dokumentationen so gelesen, die alle recht gut bewertet wurden.

[CyberDemon]

Ich hätte es auch direkt unter dem Inhaltsverzeichnis gesetzt.

[SAPler]

Ich habe direkt nach der Einführungsseite bzw. vor dem Inhaltsverzeichnis ein Glossar entwickelt. Hier waren zum Beispiel die unterschiedlichen Schriftarten mit Erklärung zu finden. Z.B. habe ich für Tabellen und Wertefelder eine separate Schriftart genommen, für eigenentwickelte Programme eine andere und eben auch für Wörter, die erklärt werden müssen.

Okay, es war vielleicht auf den ersten Blick etwas unübersichtlich, aber der PA hat diese Lösung sehr gelobt und fand sich auch sehr gut damit zurecht. So konnten Sie auf den ersten Blick beim Lesen der Doku bereits die einzelnen Namen einordnen.