RTFC Hypertext-Compiler | |||||||||||
|
RTFC Hypertext-Compiler 2.5 Richtlinien für Autoren Index
Es ist selbstverständlich, dass Sie Fragen zur Rechtschreibung
mit Hilfe des Duden klären, den es auch online gibt:
Darüber hinaus hat sich in der Alltagspraxis professioneller Schreibkräfte
die DIN 5008 durchgesetzt, die als Norm für die
Textverarbeitung am PC besonders auf das Verfassen von Briefen eingeht.
Dieses auch als "Sekretärinnen-Norm" bekannte Regelwerk enthält
speziell für die Schreibung von Abkürzungen und besonderen zahlendarstellungen
nützliche Festlegungen. In seltenen Fällen widerspricht die DIN dem Duden,
z. B. wenn es um die Schreibung des Bis-Strichs geht, der laut DIN
von Leerzeichen umgeben wird, laut Duden jedoch nicht. In solchen Fällen
hat sich die DIN in der Praxis durchgesetzt, weshalb wir Ihnen dringend
empfehlen, die einschlägigen Quellen zur DIN 5008 im Internet in
Betracht zu ziehen. Empfehlenswert ist hier beispielsweise die Seite:
Füllen Sie in der Registerkarte "Zusammenfassung"
bzw. "Datei-Info" in den Datei-Eigenschaften von Microsoft
Word zumindest die Punkte "Titel", "Autor", "Firma",
"Stichwörter" und "Kommentar" aus, damit diese in HTML-Seiten
und anderen E-Buch-Formaten übernommen werden können. Sie können darin
auch URLs (Hyperlinks in der Form " http://www.domain.de/seite.htm")
oder Ihre E-Mail-Adresse (in der Form " name@domain.de"
angeben, damit Sie im Fußteil jeder erzeugten Seite erscheint. Die Firmenangabe
ist für das Copyright wichtig.
Eine klar strukturierte Gliederung ist das A und O einer guten Dokumentation.
Der "rote Faden" sollte bereits im Inhaltsverzeichnis ersichtlich
sein. Dadurch wird die praktische Verwendbarkeit ungemein aufgewertet.
Die Gliederung hilft auch dem Autor, sein Ziel systematisch zu erreichen
und Wichtiges von Unwichtigem zu trennen.
Eine einmal in der Gliederung gewählte "Logik" sollte für die
gesamte Dokumentation beibehalten werden (wichtig bei ähnlich aufgebauten
Kapiteln mit wiederkehrenden oder äquivalenten Gliederungspunkten). Das
gilt auch für ähnliche Textteile im Fließtext.
Jede Gliederungsebene muss mindestens 2 Punkte umfassen,
sonst ist sie überflüssig (wer "A" sagt, muss auch "B"
sagen).
Eine weitere Untergliederung innerhalb des Textes (z. B.
mit Großbuchstaben, römischen Ziffern und Kleinbuchstaben) ist nur bei
begründeter Notwendigkeit vorzusehen. In diesem Fall sind Großbuchstaben
und römische Ziffern mit Punkten, Kleinbuchstaben mit Klammern abzuschließen.
Wörtliche Zitate müssen mit Anführungszeichen kenntlich
gemacht werden. An solchen Zitaten darf nichts verändert werden −
eventuelle Schreibfehler müssen übernommen werden. Wird nur ein Teil
des Satzes zitiert, so ist dies mit Auslassungspunkten (...) zu verdeutlichen.
Eigene Anmerkungen innerhalb eines Zitats müssen in Klammern gesetzt und
mit dem Zusatz "Anm. d. Verf." versehen werden.
Zu jedem Zitat gehört eine Quellenangabe, die als Fußnote
und / oder Verweis auf den Quellennachweis am Ende der Dokumentation ausgeführt
werden kann. Auch bei sinngemäßen Zitaten (ohne Anführungszeichen) ist
eine Quellenangabe notwendig.
Wird die gleiche Quelle direkt nacheinander mehrmals
zitiert, kann die Quellenangabe auf den Vermerk "ebd." (ebenda)
und die Seitenzahl reduziert werden.
Wird die gleiche Quelle durch andere Quellen getrennt mehrmals zitiert,
so kann man sich mit der Angabe des Verfassers und dem
Vermerk "a. a. O." (am angegebenen Ort), sowie der Seitenzahl
auf die bereits vorhandene Quellenangabe beziehen. Falls mehrere Werke
des gleichen Verfassers verwendet wurden, muss der Titel des Werkes in
Kurzform erwähnt werden.
Quellenangaben und Copyright
Gerade für Publikationen im Internet sollten Sie auf
klare Quellenangaben und Copyright-Vermerke (auch im eigenen Interesse)
nicht verzichten.
Jede Quellenangabe ist nach folgendem Schema aufgebaut:
Nachname, Vorname: "Buchtitel - Untertitel", Auflagennummer,
Ort Jahr, Verlag, Heftnummer, Seitenzahl
Angaben, die unbekannt bzw. irrelevant sind, können
ausgelassen werden. Falls mehrere Verfasser beteiligt sind, sind alle weiteren
Namen nach dem Vornamen des ersten Verfassers zu nennen.
Wer nicht nur einzelne Sätze aus einer Publikation zitiert,
sondern ein ganzes Kapitel, einen kompletten Artikel oder den gesamten
Inhalt veröffentlichen will, muss für diesen Zweck eine schriftliche
Genehmigung beim Verlag oder Autor einholen. Die Veröffentlichung muss
einen Hinweis auf die erteilte Genehmigung enthalten. Auch im Internet
sollten Sie den Autor darüber Informieren, wenn Sie einen Hyperlink auf
seine Seiten vorsehen wollen.
Verwenden Sie möglichst allgemein gebräuchliche Begriffe,
die von einer breiten Leserschaft verstanden werden. Wo dies nicht möglich
ist, sollte ein Glossar zur Erläuterung unbekannter Begriffe hinzugefügt
werden.
Wenn Sie Windows-Software beschreiben: halten Sie sich
an die von Microsoft vorgeschlagene Terminologie von Windows-Fachbegriffen
(Beispiel: "Button" = "Schaltfläche", "Scrollbar"
= "Rollbalken" usw.). Die Hilfen von Microsoft-Produkten können
dabei als Vorbild dienen.
Eine serifenlose Schrift steigert die Lesbarkeit elektronischer Dokumente.
Standardtext und Überschriften, sowie spezielle Textteile wie Zitate sollten
sich durch unterschiedliche Formatierungen und entsprechende Abstände
deutlich voneinander unterscheiden. Einen Anhaltspunkt geben folgende Richtwerte:
2.5.1 Technische Randbedingungen 2.6 Verknüpfen der Hilfe mit einem Anwendungsprogramm
Erstellt: 01.12.2010 18:00 Aktualisiert: 04.12.2024 09:00
Autor: Dipl.-Ing. (FH) W. Hubert Copyright © 2024 RTFC Service |