Ein Glossar in der Dokumentation

[-Overlord-]

Hallo Leute

Bin gerade noch bei meiner Doku dabei und stehe gerade vor der Wahl, ein Glossar zu machen. Hab das zwar bis jetzt noch angegeben, aber weiß nich so recht... hatte einen Kumpel der schon bestanden hat gefragt, welche der Wörter (hab ihm ne Liste geschickt) ich nicht erklären muss.

Er meinte dann, dass er selbst keins gemacht hat und das eigentlich auch nich sein muss. Weil da halt fuchse Leute sitzen die das eigentlich alles können.

Deswegen nun die Frage:

-Glossar ja oder nein

-oder nur minimal... so harte Sachen wie (e-Procurement-Vertrag)

Greetz

Overlord

[benni.alp]

Ich werde eines schreiben. Gehört sich in einer Doku einfch so!

[Gast]

Es wird von den Prüfern durchaus Wert auf ein Glossar gelegt.

[IJK]

Ich erwarte als Prüfer ein Glossar, außer es sind wirklich keine "fachlich auffälligen" Begriffe dabei :mod:

[Gast]

außer es sind wirklich keine "fachlich auffälligen" Begriffe dabei

Dann stellt sich mir die Frage: kann man eine fachliche Dokumentation ohne Verwendung von Fachbegriffen verfassen?

[-Overlord-]

Mhh das sind die Wörter, die ich bis jetzt habe....

e-Procurement-Vertrag

Premium-Support-Vertrag

Datenserver

VPN Gateway

Webserver

FTP

Zwangstrennung

IP-Adresse

WAN

Hardware

Client Software

IPSec

L2TP

DynDNS Verfahren

ADSL2+ Internetleitung

Raid 1 - Mirroring (Spiegeln)

PPTP

Pre-Shared-Key

RAS-Richtlinien

Router

NAT

Gibt es da eins, welche ich nun nicht unbedingt beschreiben muss?

[IJK]

@ -Overlord-

Genau sowas erwarte ich - mit Erläuterungen :floet:

@Chief

Ich habe es zumindest noch nicht gesehen - aber möglich ist alles :beagolisc

[1pruefer]

Bei der Liste würde ich gar nichts streichen.

Gute Definitionen - anstelle liebloser Zitate aus Wikipedia o.ä. - zeigen mir fundiertes Verständnis des Projekthintergrunds. Habe gestern eine Projektdoku bewertet, die aufgrund eines guten Glossars näher an 100 herangekommen ist.

Und das Glossar bitte alphabetisch sortieren.

[benni.alp]

Mhh das sind die Wörter, die ich bis jetzt habe....

VPN Gateway

Client Software

ADSL2+ Internetleitung

Kleinr Tipp, da die Doku in deutscher Sprache geschrieben wird:

Lass die sog. "Deppenleerzeichen" raus!

VPN-Gateway

Client-Software

ADSL2+-Internetleitung (oder "ADSL2+"-Internetleitung)

[Devastator]

Hallo. Ich bin auch grade dabei ein Glossar für meine Doku zu schreiben.

Allerdings bin ich mir bei so einigen Begriffen nicht so sicher ob sie da rein müssen. Hier meine Begriffe die ich so habe:

Intranet

Putty(das Programm)

Datenbank*

Konfigurationstool

Break-Even-Point

Basisklasse*

Datensatz*

Tabelle*

SQL

Index ( im Sinne von Tabellenindex )

Auto Increment

Access Methode

Attribut*

String* ( der Datentyp )

Dienst ( Dienst der auf einem Server läuft )

Würdet ihr davon etwas raus lassen??

Grade bei den mit * gekennzeichneten Begriffen bin ich mir nicht sicher ob die rein müssen

Vielen dank für eure Meinungen.