Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches...

35
Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005

Transcript of Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches...

Page 1: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Technisches Schreiben

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

Vortrag

Technisches Schreiben

23.05.2005

Page 2: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Technisches Schreiben

Gliederung des Vortrags

- 1. Klarheit, Kürze, Klang

- 2. Einfachheit

- 3. Modewörter und Amerikanismen

- 4. Struktur

- 5. Quellenverzeichnis

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

Page 3: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Klarheit

Ursachen, die zu unklarem Schreiben führen:

- gegen die Sprachlogik verstoßen

- falsche Wörter gewählt

- verschiedene Wörter für dieselbe Sache gewählt

- undefinierte Begriffe verwendet

- missverständliche Wörter gewählt

- zu allgemeine Aussagen gemacht

- mehrdeutige Wörter und Sätze verwendet

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

Page 4: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Sprachlogik Beispiel 1

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 17, es wird ein anderes Buch über Betriebssysteme zitiert:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Die Zwischenablage ist ein Dienst, der gewöhnlich vom Betriebssystem bereitgestellt wird. Das Betriebssystem reserviert dafür Bereiche auf der Festplatte. Anwendungen können Daten in die Zwischenablage schreiben.“

Page 5: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Sprachlogik Beispiel 2

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 18, eine oft vorkommende Redewendung:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Die drei ersten Kapitel des Buches bilden die Einführung.“

„Die ersten drei Kapitel des Buches bilden die Einführung.“

Page 6: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Das treffende Wort

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 19, jemand schreibt über Prozesskommunikation:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Beim blockierenden Senden kehrt die Operation erst dann zurück, wenn der Sendepuffer vom Kommunikationssystem ausgelesen ist und wieder zur Verfügung steht.“

„Beim blockierenden Senden kann der sendende Prozess erst dann weiterlaufen, wenn das Kommunikationssystem die im Sendepuffer stehende Nachricht vollständig abgeholt hat.“

Page 7: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Synonyme

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 20 ff:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

der Pfarrer - der Gottesmann

die Grünen - die Umweltschutzpartei

Wahl - Urnengang

Mond - Erdtrabant

Fußball - das runde Leder

Anwender - Benutzer - Nutzer - User

Page 8: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Missverständliche Wörter

effizient

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„wirtschaftlich“ oder „leistungsfähig“

Eigenschaft von Vorgängen

effektiv

„wirksam“ oder „tatsächlich“

beschreibt Gesamtwirkung von Teilwirkungen

Page 9: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Zu allgemeine Aussagen

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 28:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Im Endeffekt können Prolog-Programme (fast) so schnell wie Programme in prozeduralen Sprachen ausgeführt werden.“

„Vergleichende Tests zeigen, dass Prolog-Programme (fast) genau so schnell wie äquivalente Programme in prozeduralen Programmiersprachen ausgeführt werden können.“

Page 10: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Mehrdeutigkeit

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 30:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Er sah das Mädchen mit dem Fernglas.“

„Vater von vier Kindern in den Tod gerissen.“

„Bettlägeriger nach Zimmerbrand durch Grablicht gerettet.“

Page 11: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Kürze

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 32:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Die Vorlage wird in Aufsicht (bei Druckvorlagen) oder Durchsicht (bei Dias) beleuchtet.“

„Die Vorlage wird beleuchtet (bei Druckvorlagen) oder durchleuchtet (bei Dias).“

„Druckvorlagen werden beleuchtet, Dias durchleuchtet.“

Page 12: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Klang

Ursachen, die zu schlechtem Klang führen:

- ähnliche Wörter werden in zu geringem Abstand wiederholt

- unerwartetes Zusammenstoßen unbetonter, kurzer Wörter

- grammtikalische Fehler

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

Page 13: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Klangwiederholungen

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 36, es wird eine Überschrift einer Seminararbeit zitiert:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Von von Neumann zum Hochleistungsmikroprozessor.“

„Von den Anfängen zum Hochleistungsmikroprozessor.“

Page 14: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Unerwartetes Zusammenstoßen von Wörtern

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 36 f:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Der Prozessor ist über den oder die Busse mit dem Hauptspeicher verbunden.“

„Der Prozessor ist über Busse mit dem Hauptspeicher verbunden.“

Page 15: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Klarheit, Kürze, Klang Technisches Schreiben

Aktiv und Passiv in einem Satz

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 37:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Die Sprachelemente des imperativen Programmierens unterstützen zwar das strukturierte Programmieren; damit wird jedoch nicht das Programmieren im Großen unterstützt.“

„Die Sprachelemente des imperativen Programmierens ermöglichen zwar das strukturierte Programmieren, jedoch nicht das Programmieren im Großen.“

Page 16: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Einfachheit Technisches Schreiben

Zu lange Sätze - Beispiel

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 47:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Schließlich sei zum Abschluss dieses Unterkapitels noch darauf hingewiesen, dass streng genommen auch der Begriff des Mikroprozessors für die heute erhältlichen Universalbausteine irreführend ist, weil diese zusätzlich zu den Funktionen des Prozessors im allgemeinen Teile des Speichers (insbesondere Cachespeicher und Ansteuerungen) sowie des Verbindungswerkes (insbesondere der Bussteuerung) beinhalten.“

Page 17: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Einfachheit Technisches Schreiben

Zu lange Sätze - Berichtigung

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 48:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Der Begriff ‚Mikroprozessor’ ist nicht ganz korrekt, denn heutige Mikroprozessoren enthalten neben dem eigentlichen Prozessor zusätzliche Komponenten wie Caches, Bussteuerung und anderes.“

Page 18: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Einfachheit Technisches Schreiben

Zu kurze Sätze

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 51, es wird aus der Diplomarbeit eines Chemiestudenten zitiert:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Gründe für diese Zusammenhänge könnten einerseits unterschiedliche Reaktionsgeschwindigkeiten zwischen Cannizar-Reaktion und Esterbildung sein. Andererseits könnte aber auch eine Instabilität der Ester dafür verantwortlich sein. Für letzteres spricht die geringe Esterbildung bei 300°C. Bei zu geringen Temperaturen wird jedoch kein Ester gebildet.“

Page 19: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Einfachheit Technisches Schreiben

Passiv vermeiden

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 54:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Grundsätzlich kann zwischen Tastaturen mit und ohne fühlbarem Druckpunkt unterschieden werden.“

„Man unterscheidet Tastaturen mit und ohne fühlbarem Druckpunkt.“

Page 20: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Einfachheit Technisches Schreiben

Unnötige Adjektive

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 56:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

feste Überzeugung - ist eine Überzeugung nicht immer

ein fester Glaube?

dicke Trosse - dünne Trossen sind Seile

blutiges Massaker - ein Massaker ist ein Blutbad

überwiegende Mehrheit- die Mehrheit überwiegt immer

unwiderleglicher Beweis- ein Beweis, der widerlegt werden kann,

ist keiner

exemplarisches Beispiel - Exempel und Beispiel sind dasselbe

dynamische Vorgänge - Vorgänge sind immer dynamisch

Page 21: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Einfachheit Technisches Schreiben

Verstöße gegen die Logik

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 59:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Eine erste Zielsetzung der Informationstheorie besteht im Entwurf von günstigen Codierungen für eine gegebene Quelle.“

„ungleich höher“

„ungleich schöner“

Page 22: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Modewörter

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 71 f:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Bevor eine neue Datei eröffnet werden kann, muss sie zuerst kreiert werden.“

„Bevor eine neue Datei eröffnet werden kann, muss sie zuerst erzeugt (oder angelegt) werden.“

„Bevor eine neue Datei geöffnet werden kann, muss sie zuerst erzeugt (oder angelegt) werden.“

Page 23: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Modewort „Herausforderung“

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 73:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Die Erstellung fehlerloser großer Programme ist eine Heraus-forderung an die Informatik-Forschung.“

Page 24: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Modewort „ultimativ“

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 73, es wird ein Informatikbuch zitiert:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Computer werden oft als ultimative Autorität betrachtet – sie sind allwissend und haben immer recht.“

Page 25: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Modewort „Quantensprung“

Beispiel ist Zitat aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 73, es wird eine Kritik einer Theaterinszenierung zitiert:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Exemplarisches Beispiel für Witz, kombiniert mit politischer Schärfe: Mit seiner außergewöhnlichen Inszenierung der ’Blume von Hawaii’ sorgte der Regisseur im Vorjahr für einen Quantensprung in der Operettengeschichte am Linzer Landestheater.“

Page 26: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Modewort „entscheidend“

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 74:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Entscheidendes Leistungsmerkmal von Bussen ist ihre Übertragungsrate.“

„Der entscheidende Schwachpunkt des Data Encryption Standard ist die unzureichende Größe des Schlüsselraums und die dadurch resultierende Möglichkeit zu brute-force Angriffen.“

Page 27: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Modewort „nutzen“

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 77:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„Einige Dokumentsuchsysteme wurden für kleine Dokument-sammlungen, Sachgebiete und Gruppen von Nutzenden konzipiert.“

„Die wohl am häufigsten genutzte Form der direkten Kommunikation über das Internet ist die elektronische Post, genannt E-Mail.“

„Nutze die Zeit, benutze die Bahn.“

„Ich benutze meinen Garten zur Erholung; aber ich nutze ihn nicht, denn er ist kein Nutzgarten.“

Page 28: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Offene Amerikanismen

„Babysitter“

„Blackout“

„EuroCard“

„Container“

„Feature“

„Fitness Center“

„User“

„Workshop”

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

Page 29: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Verborgene Amerikanismen

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 80:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

„adoptieren von ‚to adopt’ (richtig: ‚übernehmen’)“

„kontrollieren von ‚to control’ (richtig: ‚steuern’ oder ‚regeln’)“

„Kopie von ‚copy’ (richtig manchmal: ‚Exemplar’)“

Page 30: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Modewörter und Amerikanismen Technisches Schreiben

Amerikanismen der Informatik

Beispiele sind Zitate aus dem Buch „Technisches Schreiben“ von Peter Rechenberg, Seite 82 f:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

application - Anwendung

compiler - Übersetzer

deadline - Endtermin

display - Bildschirm, Anzeige

exception - Ausnahme

message - Botschaft, Nachricht

operating system - Betriebssystem

parser - Syntaxanalysator

tool - Werkzeug

workshop - Arbeitskreis

Page 31: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Struktur Technisches Schreiben

Gliederung einer Diplomarbeit

Zusammenfassung

Aufgabe

Methodik und Durchführung der Arbeit

Ergebnisse

Literaturverzeichnis

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

aus „Technisches Schreiben“ von Peter Rechenberg, Seite 114:

Page 32: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Struktur Technisches Schreiben

Literaturverzeichnis

Verfasser: Titel. [Band.] [Auflage.] Ort : Verlag, Jahr. [-ISBN]

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

aus „Technisches Schreiben“ von Peter Rechenberg, Seite 121:

„Riedl, Rupert ; Kaspar, Robert (Mitarb.): Biologie der Erkenntnis : Die stammesgeschichtlichen Grundlagen der Vernunft. 3. Aufl. Berlin : Parey, 1981.-ISBN 3-489-61034-2“

Page 33: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Struktur Technisches Schreiben

Nummerierung

aus „Technisches Schreiben“ von Peter Rechenberg, Seite 113:

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

Erstes Kapitel: Überschrift 1. Ordnung

1. Überschrift 2. Ordnung

A. Überschrift 3. Ordnung

I. Überschrift 4. Ordnung

a. Überschrift 5. Ordnung

aa. Überschrift 6. Ordnung

1 Kapitel

1.1 Abschnitt

1.1.1 Unterabschnitt

Page 34: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Struktur Technisches Schreiben

Verweise

- Seitenverweis („siehe Seite 345“)

- Kapitel- oder Abschnittsverweis („siehe Abschnitt 1.2.3.“)

- Bild- oder Tabellenverweis („siehe Bild 12.4“)

- Randnummernverweis („siehe (12)“)

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

aus „Technisches Schreiben“ von Peter Rechenberg, Seite 117:

Page 35: Technisches Schreiben Oberseminar Softwareentwicklung Carsten-Dominik Traenkle Vortrag Technisches Schreiben 23.05.2005.

Quellen Technisches Schreiben

Quellen

Oberseminar Softwareentwicklung Carsten-Dominik Traenkle

- „Rechenberg, Peter: Technisches Schreiben. 2. Aufl. München : Hanser, 2003.-ISBN 3-446-22472-6

- eigene Seminararbeiten