Fachliches in der Doku

[Hektiker]

Hallo erstmal. Die Prüfungen rücken näher, die Hose wird nass -> Schnell zu Gleichgesinnten.

Hier also meine erste Frage:

Hat evtl. jemand ne Ahnung, wie ich die Doku bezgl. vorausgesetzte Fachkenntnisse aufbauen soll?

Unser Ausbilder sagt, man solle es leicht verständlich erklären, so dass es auch Sußenstehende verstehen würden. In anderen Postings hab ich nun gelesen, dass man fachlich bleiben soll, da im Prüfungsausschuss ja Fachleute sitzen.

Konkretes Beispiel: Das Vereinzlermodul in Geldautomaten. Ist eigentlich für den Bankbereich ein absolut bekanntes Teil, aber für Außenstehende?

Für den Fall: Kennt jemand eine Seite, wo es Sachen wie "richtiges Verweisen", "Erklären von Fremdwörtern, Abkürzungen" u.ä. nachzulesen gibt? Viele wissen nix, und die die was wissen, sagen alle was anderes.

Also dann...

Hektiker

[kreisler]

Hallo Hektiker!

Die Frage "wie viel muss ich erklären" musst du dir leider selbst beantworten.

Da musst du ein Gefühl für haben oder entwickeln --> in die Zielgruppe hineinveretzen

. Ich kann dir da nur die bekannten Sprüche "So wenig wie möglich, aber so viel wie nötig" oder "Nachvollziehbar erklären, aber niemanden für dumm halten" anbieten.

Zum Thema "richtig Verweisen" oder Zitieren etc:

Schau auf Uli's Prüfungspage (http://devnull.owl.de/~caesar)

Gruß

kreisler

P.S.: Keine Hektik, Hektiker

[Webentwickler]

Ahoi Hektiker,

herzlich willkommen im Board!

Das hängt von Deiner Zielgruppe ab. Vor wissenden würde ich anders präsentieren als vor "Dau´s".

------------------

Webentwickler

http://www.wetterfee.com

[Jo]

Hallo Hektiker,

ich habe in einigen Projektdokumentationen gesehen, dass die Leute in der Einführung die Zielgruppe erwähnt haben. Das ist dann zwar kein Freibrief für Fremdwörter aber würde einiges "erlauben". Auf jeden Fall würde ich Dir einen Glossar als Anhang empfehlen, in dem Du Wörter wie oben genanntes definierst. Muss ja nicht jedes drin stehen.

Im Endeffekt werden sie dein Projekt eh nicht nach jedem unbekannten Wort durchsuchen.

Viel Glück Jo

[Tasjopeia]

mein vorschlag wäre ja, nicht ganz so in detail gehen, denn das was du in deiner doku schreibst verwendet die ihk für fragen in dem fachgespräch.

bei mir ist es auch im sommer soweit, bibber.

ciao und viel glück

[Chipsy]

<BLOCKQUOTE><font size="1" face="Verdana, Helvetica, sans-serif">Zitat:</font><HR>Original erstellt von

:

mein vorschlag wäre ja, nicht ganz so in detail gehen, denn das was du in deiner doku schreibst verwendet die ihk für fragen in dem fachgespräch.

bei mir ist es auch im sommer soweit, bibber.

ciao und viel glück

[Chipsy]

Ach so naoch was vergessen...

@Hektiker:

Ich habe meine Doku damals fachlich geschrieben, so als ob die Doku für einen Kollegen wäre, der auch programmiert und Begriffe, die firmenspezifisch oder nur in der Programmiersprache vorkommen habe ich ein einem extra Glossar beschrieben.. nur nicht anfangen Klasse und Objekt zu erklären.. wie du schon sagtest die Prüfer sind aus dem Fach und lesen vermutlich auch in der Realität oft Fachkonzepte und Pflichtenhefte und die verstehen die bestimmt, auch wenn sie keine Programmierer sind..

Also viel Glück euch allen

Chipsy

[chiren]

hi

bei mir steht in der vorlage für prüfung was von kundengerecht und betriebliche doku (bin aber inf-kaufmann) das heißt für mich zwei dokus aber nicht unbedingt für daus - weil kunde ja auch nicht blöd ist.

als oschon fachbegriffe verwenden, aber meist mit einfachen worten erkären. nicht zu viele fachworte nd auf keinen fall nur fachworte wählen.