ProjektDokumentation, Glossar oder Abkürzungsverzeichnis?!?

[Eorlinforth]

Hallo,

nimmt man in die Doku ein Abkürzungsverzeichnis oder ein Glossar wo die Abkürzungen noch umschrieben sind?

Oder was ist da die beste möglichkeit?

Grüße

[henko]

Hallo,

ich hatte es bei mir in der Doku Glossar genannt

Dient nicht nur zum Beschreiben von Abkürzungen sondern auch von Fremdwörtern und Produkten.

[Eorlinforth]

Ja das mein ich. Ein Glossar würde ich ehr ans Ende setzten ein Abkürzungsverzeichnis würde ich nach dem Inhaltsverzeichnis setzten.

[Busted.]

Hallo Eorlinforth,

beides gehört in den Anhang und zählt nicht zum Umfang der reinen Projektdokumentation (die IHK Wuppertal z.B. fordert 9-11 Seiten Umfang). Falls Du fremde Textpassagen übernommen hast, denke unbedingt daran, die Quellen anzugeben.

[stefan.macke]

Ein Abkürzungsverzeichnis ist immer notwendig, wenn du Abkürzungen und insb. Akronyme nutzt. Auch solche, die eigentlich bekannt sein sollten, sind dort aufzuführen (z.B. ISDN, API, GUI). "DSL" kann z.B. "Digital Subscriber Line" oder "Domain Specific Language" heißen. Und um das zu unterscheiden, brauchst du ein Abkürzungsverzeichnis. Nicht aufgeführt werden müssen allgemeine Abkürzungen, die zum alltäglichen Gebrauch zählen, wie z.B. "z.B.", "ggfs.", "usw." usw.

Ein Glossar ist nur notwendig, wenn du Begriffe erklären willst, für deren Verständnis die ausgeschriebene Abkürzung nicht ausreicht. Wenn du also "ISDN" verwendest, musst du über "Integrated Services Digital Network" hinaus nicht erklären, was das ist, da du technische Kenntnisse darüber beim Prüfungsausschuss voraussetzen kannst. Ins Glossar gehören also eher Begriffe aus deiner Domäne, z.B. SAP-Spezifika, betriebsinterne Begriffe usw.

[Eorlinforth]

OK mein Thema ist WDS ich denke dann sollte ich beides nutzen also Abkürzung und Glossar.

[stefan.macke]

WDS = Windows Deployment Services? Ich bin kein FISI, aber das kenne ich ja sogar. Das Glossar würde ich mir schenken und lieber sinnvolle Inhalte in die Doku packen. Das Glossar ist doch nur eine Sammlung von Definitionen, die du nicht selbst geschrieben hast.

Was wären denn weitere Begriffe, die du im Glossar aufführen möchtest?

[Albi]

WDS = Windows Deployment Services? Ich bin kein FISI, aber das kenne ich ja sogar. Das Glossar würde ich mir schenken und lieber sinnvolle Inhalte in die Doku packen. Das Glossar ist doch nur eine Sammlung von Definitionen, die du nicht selbst geschrieben hast.

Was wären denn weitere Begriffe, die du im Glossar aufführen möchtest?

Also mein Glossar bestand aus 2,5 Seiten und 90% der Definitionen waren von mir selbst verfasst da es Erklärungen zu den XML Elementen waren die in unserer Software für die Dialogdefinitionen zuständig sind und es keine wirklichen vorgefertigten Definitionen dazu gibt und ein paar Softwarespezifische Fachbegriffe die auch nirgends Dokumentiert sind.

Aber klar meistens sind Glossare nur Kopierte Definitionen, die kann man sich natürlich sparen

Gesendet von iPhone mit Tapatalk

[stefan.macke]

da es Erklärungen zu den XML Elementen waren die in unserer Software für die Dialogdefinitionen zuständig sind

Dann ist ein Glossar ja auch völlig in Ordnung und sogar notwendig, da die Prüfer sonst den Inhalt der Dokumentation nicht verstehen können.

[Eorlinforth]

Hätte im Glossar noch sowas wie PXE, TFTP, DHCP, AD DS, Sachen aus der Antwortdatei. Eben die Fachbegriffe die abgekürzt in dem Projekt sind. Zusätzlich mit meinen noch.

Sowas wie PXE ok das sollten die prüfer wissen. Ich hab nur Angst was zu vergessen. Lieber im Anhang ein Glossar und bisle mehr als das weg lassen oder?

Die frage ist eben ob auch Abkürzungsverzeichnis. Welches am Anfang hin kommt und beim Lesen unterstützen soll.

Glossar versteh ich so das es eben zusätzlich noch umschreibt was es ist.