TECHNISCHES SCHREIBEN

Transkript

1 christoph prevezanos TECHNISCHES SCHREIBEN FÜR INFORMATIKER, AKADEMIKER, TECHNIKER UND DEN BERUFSALLTAG

2 Prevezanos Technisches Schreiben Bleiben Sie auf dem Laufenden! Der Hanser Computerbuch-Newsletter informiert Sie regelmäßig über neue Bücher und Termine aus den verschiedenen Bereichen der IT. Profitieren Sie auch von Gewinnspielen und exklusiven Leseproben. Gleich anmelden unter

3

4 Christoph Prevezanos Technisches Schreiben Für Informatiker, Akademiker, Techniker und den Berufsalltag

5 Der Autor: Christoph Prevezanos, Bielefeld Alle in diesem Buch enthaltenen Informationen, Verfahren und Darstellungen wurden nach bestem Wissen zusammengestellt und mit Sorgfalt getestet. Dennoch sind Fehler nicht ganz auszuschließen. Aus diesem Grund sind die im vorliegenden Buch enthaltenen Informationen mit keiner Verpflichtung oder Garantie irgendeiner Art verbunden. Autor und Verlag übernehmen infolgedessen keine juristische Verantwortung und werden keine daraus folgende oder sonstige Haftung übernehmen, die auf irgendeine Art aus der Benutzung dieser Informationen oder Teilen davon entsteht. Ebenso übernehmen Autor und Verlag keine Gewähr dafür, dass beschriebene Verfahren usw. frei von Schutzrechten Dritter sind. Die Wiedergabe von Gebrauchsnamen, Handelsnamen, Waren be zeich nungen usw. in diesem Buch berechtigt deshalb auch ohne besondere Kennzeichnung nicht zu der Annahme, dass solche Namen im Sinne der Warenzeichen- und MarkenschutzGesetzgebung als frei zu betrachten wären und daher von jedermann benutzt werden dürften. Bibliografische Information der Deutschen Nationalbibliothek: Die Deutsche Nationalbibliothek verzeichnet diese Publikation in der Deutschen Nationalbiblio grafie; detaillierte bibliografische Daten sind im Internet über abrufbar. Dieses Werk ist urheberrechtlich geschützt. Alle Rechte, auch die der Übersetzung, des Nachdruckes und der Vervielfältigung des Buches, oder Teilen daraus, vorbehalten. Kein Teil des Werkes darf ohne schriftliche Genehmigung des Verlages in irgendeiner Form (Fotokopie, Mikrofilm oder ein anderes Verfahren) auch nicht für Zwecke der Unterrichtsgestaltung reproduziert oder unter Verwendung elektronischer Systeme verarbeitet, vervielfältigt oder verbreitet werden Carl Hanser Verlag München, Lektorat: Brigitte Bauer-Schiewek Copy editing: Petra Kienle, Fürstenfeldbruck Herstellung: Irene Weilhart Umschlagdesign: Marc Müller-Bremer, München Umschlagrealisation: Stephan Rönigk Gesamtherstellung: Kösel, Krugzell Ausstattung patentrechtlich geschützt. Kösel FD 351, Patent-Nr Printed in Germany Print-ISBN: E-Book-ISBN:

6 Inhalt Vorwort Einstieg technisches Schreiben IX Was macht technisches Schreiben aus? Für wen dieses Buch gemacht ist Was dieses Buch bietet Ihr technisches Schreibwerkzeug Die richtige Textverarbeitung Microsoft Office Word OpenOffice/LibreOffice Corel WordPerfect LaTeX XML-Umgebungen Adobe FrameMaker Content Management Systeme Arbeiten mit Vorlagen Vorlagen erstellen und definieren Wichtige Vorlagen im Überblick Die passende Schriftart wählen Mit oder ohne Serifen Proportionale und nichtproportionale Schriften Die Schriftgröße Die Seitengestaltung Das Seitenformat Die Seitenränder Gegenüberliegende Seiten Der Zeilenabstand Die Normseite Weitere Seitenelemente Spalten Kopf- und Fußzeilen

7 VI Inhalt Seitenzahlen Randnummern Absatznummern Planung und Organisation Die Art der Arbeit genau deklarieren Inhalt und Anforderungen Umfang Zeitplanung Strukturierung der Arbeit Alles beginnt mit der Gliederung Sinn und Zweck der Gliederung Formale Regeln für die Gliederung Der Dokumentenaufbau Das Titelblatt (innen und außen) Impressum Vorwort Inhaltsverzeichnis Der Text Literaturverzeichnis Anhänge Glossar Stichwortverzeichnis Den Haupttext richtig strukturieren Das Dokument in Teile aufteilen Die Unterteilung in Kapitel Überschriften und Ebenen Die Spitzmarke als Zwischenelement Sinnabschnitte richtig unterteilen Beispielgliederungen Handwerkliches Grundwissen Richtig zitieren Das direkte Zitat Das Blockzitat Fremdsprachige Zitate Das indirekte Zitat Deklarationen innerhalb des Zitats Der korrekte Beleg Die Zitierfähigkeit und Zitierwürdigkeit Literaturangaben in der Informatik Vorsicht vor Plagiaten

8 Inhalt Internetquellen und E-Books Fußnoten Zahlen im Text verwenden Querverweise Formelzeichen Typografie und Interpunktion Anführungszeichen Bindestriche und Gedankenstriche Abkürzungen und Leerstellen Maßeinheiten Tasten und Funktionen Sprache und Ausdruck Der gute Schreibstil Die richtige Wortwahl Guter und schlechter Satzbau Sie, Du, wir, man wie man den Leser anspricht Die Geschlechterfrage Fehlercheckliste Fremdwörter, Modewörter und Fachbegriffe Allgemeines zur Entwicklung der Sprache Die Gefahr von Modewörtern Problematische Modewörter Verbotene Modewörter Anglizismen und wie man damit umgeht Unnötige Begriffe aus dem Englischen Die Sprache der Informatiker Akronyme, Marken und Abkürzungen Richtig übersetzen falsche Freunde Bilder und Tabellen verwenden Die Auswahl der Bilder Nummerierung und Unterschrift Bilder formatieren Bildformate und Typen Bildformate Bildtypen Eigene Bilder und externe Bildquellen Bilder aus verschiedenen Quellen Bildquellen richtig deklarieren Was Sie noch beachten müssen VII

9 VIII Inhalt 8.6 Tabellen im Text nutzen Nummerierung und Überschrift Gestaltungshinweise für Tabellen Verzeichnisse, Anhänge und Index Das Literaturverzeichnis Bücher der Standardeintrag Fachzeitschriften E-Books Internetquellen Filmquellen Formatierung der Literatureinträge Literatur in der Informatik Das Abbildungsverzeichnis Der Anhang Das Abkürzungsverzeichnis Das Symbolverzeichnis Weitere mögliche Auflistungen Zusätzliche Inhalte anhängen Das Glossar Das Stichwortverzeichnis Normen und Standards im Überblick Normen für Dokumente Allgemeine Qualitätsnormen Übersicht weiterer Normen Glossar Literaturverzeichnis Index

10 Vorwort Technisches Schreiben ist für viele Menschen zu einer alltäglichen Aufgabe geworden. Dabei sind die meisten davon gar keine technischen Autoren oder gar Redakteure. Vielmehr ist das Schreiben ganz nebenbei zu einem Teil ihrer Arbeit geworden und in der Regel wird es immer mehr. Das fängt oft mit kleinen Memos in der Firma an, geht über Protokolle der letzten Sitzung, führt zur Vorbereitung für den nächsten Workshop und schließlich schreibt man das Begleitmaterial für eine Gruppenarbeit. Meist ist dann der Weg zur Produktdokumentation oder zur Arbeitsanweisung nicht mehr weit. Selbstverständlich gibt es auch sehr viele Bereiche, in denen Schreiben von Anfang an zu den eigenen Hauptaufgaben zählt. Dazu gehört sicherlich die gesamte akademische Ausbildung. Während des Studiums müssen ständig Haus-, Studien- und Seminararbeiten angefertigt werden. Dazu kommen Magister-, Diplom-, Bachelor- und Master-Arbeiten. Das wird wie selbstverständlich von allen Studenten und Studentinnen erwartet. Technisches Schreiben ist also schon lange keine Aufgabe von Informatikern mehr. Vielmehr wird es heute in fast allen Berufen, Ausbildungen und Hochschulen verlangt. Leider wird diese überaus anspruchsvolle Aufgabe meist wie selbstverständlich von einem verlangt, ohne dass vorher eine Einarbeitung, Schulung oder zumindest grundlegende Erläuterung stattgefunden hätte. Selbst in der Schule, der Fachhochschule oder in der Universität gibt es kaum vernünftige Einarbeitungen. Stattdessen muss sich jeder die notwendigen Informationen selbst zusammensuchen und eine eigene Arbeitsweise entwickeln. Genau dieses Problem will dieses Buch lösen. Es zeigt die Grundlagen des technischen Schreibens und führt Sie Schritt für Schritt durch die Erstellung Ihres Textes. Dazu wird mit grundlegenden Überlegungen angefangen, ein Blick auf das Arbeitswerkzeug geworfen und handwerkliches Schreibgrundwissen vorgestellt. Anschließend geht es direkt mit der Gliederung, dem Schreiben und der Überprüfung des eigenen Textes los. Am Ende steht das fertige technische, fachliche oder wissenschaftliche Dokument. Viel Erfolg und viel Spaß! Christoph Prevezanos Bielefeld, August 2013