Doku-Glossar

[matthias77]

Hallo,

ich bin gerade dabei meine Doku zuschreiben und da stellt sich mir jetzt die Frage welche Begriffe ich in einen Glossar erklären sollte.

In meinen Projekt geht es um eine Server installation mit Exchange, SQL und Sharepoint.

Noch eine Frage hätte ich da noch, sollte die ich Form in der Doku vermieden werden?

Danke.

[hume]

Ich hab gar kein Glossar in meiner Doku

[Blackcherry]

Meines Erachtens ist ein Glossar pflicht. Im Vorbereitungskurs wurden wir bei der IHK Dortmund auf diese Wichtigkeit hingewiesen.

Das Gloassar sollte so aufgebaut sein, dass auch eine Laie die Dokumentation verstehen kann. Lass am besten einen Bekannten oder Verwanden die Doku lesen, so können Begriffsunklarheiten am besten aufgedeckt werden.

VG

[hume]

Bei mir sind aber eigentlich keine unverständlichen Fachbegriffe drin, mein Projekt ist zu 90% kaufmännisch orientiert, d.h. irgendwelche Technische Abkürzungen etc. kommen nicht vor. Naja werds am Wocheende nochmal überfliegen ob ich wenigstens 5 Begriffe für ein Glossar finde

[Abd Sabour]

Bei mir sind aber eigentlich keine unverständlichen Fachbegriffe drin, mein Projekt ist zu 90% kaufmännisch orientiert

Achtung! Ich bin FIAE und was für dich einfach nur "kaufmännisch" und "sonnenklar" ist, ist für mich evtl. Facchchinesisch, weil ich von dem kaufmännischen sehr wenig Ahnung habe. Andersherum mag SOA, SOAP und WSDL für mich zum täglichen Vokabular gehören, während du dir evtl. nicht allzuviel drunter vorstellen kannst.

Also wie schon vorgeschlagen wurde: Gib deine Doku jemanden der von deinem Fach nichts/nur wenig versteht.

Cheers,

AbdSabour