Jump to content
Melde dich an, um diesem Inhalt zu folgen  

Fachliches in der Doku

Empfohlene Beiträge

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

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

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 smile.gif

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

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

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

<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

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

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

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

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. ;)

Diesen Beitrag teilen


Link zum Beitrag
Auf anderen Seiten teilen

Nimm an der Diskussion teil

Du kannst jetzt hier posten und Dich später registrieren. Wenn Du bereits über eine Konto verfügst, melde Dich jetzt an, um mit Deinem Konto zu posten.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung jetzt entfernen

  Only 75 emoji are allowed.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Clear editor

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.

Melde dich an, um diesem Inhalt zu folgen  

Fachinformatiker.de, 2019 SE Internet Services

fidelogo_small.png

if_icon-6-mail-envelope-closed_314900.pnSchicken Sie uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App


Get it on Google Play

Kontakt

Hier werben?
Oder senden Sie eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...

Wichtige Information

Fachinformatiker.de verwendet Cookies. Mehr dazu in unserer Datenschutzerklärung