Zum Inhalt springen

Glossarbegriffe im Text kenntlich machen?


piti66

Empfohlene Beiträge

Falls ein CorporateDesign vorliegt, ist soetwas darin geregelt.

In meiner Doku hatte ich im Vorwort folgenden Absatz:

Häufig verwendete Abkürzungen, firmenspezifische Bezeichnungen und nicht geläufige Ausdrücke werden in der Dokumentation fett, kursiv und blau geschrieben und im Glossar (Anhang) erläutert.
Link zu diesem Kommentar
Auf anderen Seiten teilen

Wäre das schön, wenn meine Prüflinge das machen würden. Egal wie! Nicht einmal 5 Prozent aller Dokus, die ich auf den Tisch kriege, enthalten einen Hinweis auf einen Querverweis.

gruss, timmi

würd ich allen massiv Abzug geben.

So hab ich das damals gelöst:

Anmerkung: Die im Dokument kursiv gedruckten Wörter sind im Anhang A - Glossar erklärt.

Ins Vorwort oder in die EInleitung würd ich schreiben was du genau machst und was das mit den arbeiten deiner Firma allgemine zu tun hat, also wo dein Projekt angesiedelt ist und warum du das machst

Link zu diesem Kommentar
Auf anderen Seiten teilen

Ich hab hinter jedes Wort das im Glossar stand beim ersten Auftreten ein Sternchen (*) geschrieben. Sticht nicht großartig hervor und stört so das Design nicht.

Auf der ersten Seite hab ich dann ganz unten ebenfalls ein * hingemacht und dahintergeschrieben, dass diese Wörter im Glossar erläutert werden.

Hatte in der Doku 99%.

Link zu diesem Kommentar
Auf anderen Seiten teilen

würd ich allen massiv Abzug geben.

Wenn ich solche "Fehler" wirklich mit "massivem Abzug" bestrafen wollte, dann würde eine inhaltlich vielleicht gute Arbeit dadurch unverhältnismässig stark abgewertet. Das ist ja auch nicht im Sinne des Erfinders.

Es gibt eine Bewertungs-Matrix. Und hier fliessen auch solche Form-Fehler ein.

gruss, timmi

Link zu diesem Kommentar
Auf anderen Seiten teilen

Dein Kommentar

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung wiederherstellen

  Nur 75 Emojis sind erlaubt.

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

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

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

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

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

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...