Glengamoi (Forum) · AspHeute · .NET Heute (RSS-Suche) · AspxFiles (Wiki) · .NET Blogs
ASP German Homepage Homepage
 

Liste

.NET 2.0 (1)
.NET Allgemein (16)
.NET Fu (5)
ADO.NET (11)
Aprilscherz (3)
ASP Grundlagen (44)
ASP Tricks (83)
ASP.NET (44)
ASPIntranet.de (5)
C# (28)
Datenbank (44)
Dokumentation (4)
IIS 6.0 (1)
Komponenten (29)
Optimierung (10)
Server (21)
Sicherheit (34)
Tee Off (6)
VB.NET (6)
WAP (8)
Web Services (11)
XML (9)

RSS 2.0 - Die neuesten fünf Artikel auf AspHeute.com


 

Suchen





 

English Articles
Chinese Articles
Unsere Autoren
 
Link zu AspHeute
Impressum
Werben
Anfragen

Schreib"kunst" für Programmierer, Teil II

Geschrieben von: Bernhard Spuida
Kategorie: Dokumentation

In Teil I haben wir uns mit den Grundlagen - Lesbarkeit und Verständlichkeit von Texten - beschäftigt. Heute beschäftigen wir uns mit Stilfragen und den kleinen Tricks die aus einem verständlichem technischen Text einen gut zu lesenden, interessanten Text machen.

Für diese beiden Artikel wird nichts besonderes vorausgesetzt. Außer vielleicht ein wenig Ehrgeiz, besser zu werden. Und Bereitschaft, sich durch Übung weiterzuentwickeln. Das trifft auch auf mich zu. Also mit Anregungen, Ergänzungen und konstruktiver Kritik bitte an mich wenden. Ich freue mich über alles was ich von Dir, Leser, dazulernen kann.

Stil

Hier werden wir uns mit all den kleinen Dingen beschäftigen, die annehmbare technische Texte in gutes Deutsch umwandeln. Es gibt eine Anzahl kleiner, unauffälliger 'Du sollst'- und 'Du sollst nicht'-Gebote auf die wir als Autoren bewußt achten müssen, auch wenn sie bei der Erklärung im folgenden offensichtlich zu sein scheinen.

Das vorgestellte Material ist nicht nach Wichtigkeit sortiert, es wird in der Reihenfolge präsentiert in der sie mir einfielen. Es handelt sich sozusagen um eine persönlich gefärbte 'Wunschliste' für gutes Schreiben. Für Ergänzungsvorschläge bin ich jederzeit offen: bernhard@icsharpcode.net

1. Große Worte

Als Autor sei stets bescheiden. Es mag wohl eine bestechende Verlockung sein, Vokabular zu verwenden das obskuren Werken über Sprache entlehnt sein möge, darob großartige rhetorische Obfuskation zu erzeugen woraufhin der Leser sich wohlweislich in einen Zustand vollständigen Nichtverständnisses begeben wird.

Es dürfte nach diesem Beispiel wohl klar sein, worum es hier geht: stehen zwei Worte mit gleicher Bedeutung zur Wahl, ist das einfachere Wort zu bevorzugen. Mit einer Ausnahme - ist das 'größere' Wort klarer in seiner Bedeutung, ist dieses zu bevorzugen.

Sollte man eine Häufung großer Worte in seinem Text bemerken, ist es ratsam auch die Sätze auf Überlänge zu überprüfen, da diese beiden Dinge erfahrungsgemäß zusammen auftreten.

Verwendet man jedoch immer nur das einfachste mögliche Wort, wird der Text jedoch schnell langweilig. Ein wenig Abwechslung schadet nie!

2. Anglizismen

Gerade im Bereich des technischen Schreibens ist die Verwendung von englischen (Fach)Worten oft unumgänglich, da eine genau entsprechende deutsche Vokabel häufig nicht verfügbar ist.

Dementsprechend besteht häufig eine gewisse Tendenz, englische Vokabeln unnötig zu verwenden. Dies wäre ja nicht weiter schlimm wenn diese 'Anglizismen' korrekt verwendet würden. Leider wird oft nicht auf den genauen Sinn des verwendeten Wortes geachtet, so daß durch die Verwendung des englischen Ausdruckes mitunter der Sinn des Satzes verfremdet oder sogar völlig entstellt wird.

Ein besonderer Fallstrick sind in dieser Hinsicht die 'falschen Freunde' — sinnentstellende Übersetzungen. So ist zum Beispiel das Englische 'copy' auf Deutsch meist mit 'Exemplar' besser übersetzt.

Diese Website bietet einen guten Überblick über die Probleme mit Anglizismen und 'falschen Freunden'.

3. Ego-trip

Da ein technischer Fachartikel keine Lebensbeichte oder persönliche Weltsicht des Autors darstellt, sollte das Wort 'Ich' vermieden werden. Nur in den wenigen Fällen wo persönliche Vorlieben oder Entscheidungen eine bestimmende Rolle spielen kann 'ich' verwendet werden. Bei der Begründung von Architekturentscheidungen (die man alleine getroffen hat - ohne Teammitglieder zu fragen) ist also 'ich' tolerierbar, nicht aber bei der detaillierten Beschreibung der daraus entstandenen Schnitttstellen.

'Unpersönlicher' Stil ist bereits seit Cäsar akzeptabel. Er schilderte seine Sicht des Gallischen Krieges in der dritten Person - ein Stück klassische Literatur und doch ein rein technischer Bericht über die Vorkommnisse. Die Verwendung des Passivs sollte allerdings soweit möglich vermieden werden, da es ermüdend wirkt. Wer das nicht glaubt, braucht nur einen Blick in juristische Texte zu werfen.

Wenn wir wollen, daß unsere Texte mit Interesse gelesen werden sollten wir darauf achten, daß zwischen unseren Lesern und uns Autoren eine gleichberechtigte Beziehung aufgebaut wird. 'Klassische' technische Artikel sind meist unpersönlich, heute ist dies nicht mehr die Regel. Dennoch gilt: wir haben ein Ziel, sind aber keine Verwandten.

4. Hilfe! Hilfsverben!

Mit Hilfsverben sollte man sparsam umgehen. Verwendet man sie zu häufig, wirkt der Text schnell unbeholfen.

Tut man zu viele Hilfswörter einbauen, wird der Stil schlechter werden.

Dazu muß nicht mehr viel gesagt werden, da das Beispiel die Aussage gut illustriert. Besonders das oben verwendete 'tun' und das ebenso berüchtigte 'haben' sollten vermieden werden.

5. Schachteln

Eine Folge unseres Mitteilungsdranges als Autoren ist leider oft daß wir zu viel auf einmal sagen wollen. Wir schreiben dann so 'wie unser Schnabel gewachsen ist': ohne Pause, ohne logische Gliederung. Und häufig ohne Rücksicht auf den Leser.

Unsere Sätze werden lang und länger mit Folgen für das Verständnis des Lesers — durchsetzt von Einschüben die oft unnötig sind, auch wenn sie spontan für das Verständnis nötig zu sein scheinen — welches wie bereits im ersten Teil des Artikels unter dem Kapitel 'Rekursion' erwähnt, dort wurde eine Aufteilung in einzelne Sätze empfohlen, überlastet wird.

Die schlimmste Sorte Schachtelsatz hat einen umfassenden Hauptsatz wobei das Verb am Ende des Monsters 'hängt' – ganz ohne Bezug zu Subjekt und Objekt. Also: was logisch zusammen gehört, gehört auch im Satz zusammen.

6. Passiva

Der Vorgang des Lesens ist für den Leser ohnehin anstrengend. Und der grammatikalische Begriff 'Passiv' heisst auf Deutsch nicht umsonst 'Leidensform'. Wir wollen zusammen mit unseren Lesern am Ende unseres Textes ein Ziel erreichen, statt ihnen einen Vortrag über die Möglichkeit einer Reise dorthin zu halten.

Wenn Verben von uns im Passiv verwandt werden, werden sie genauso wie unsere Leser mit Fortschreiten des Textes ermüden und unser Ziel wird nicht erreicht werden.

Unsere Leser 'erdulden' bereits unseren Text. Müssen wir die Subjekte und Objekte unserer Sätze auch noch in eine Leidenssituation bringen? Nein! Je aktiver die Verwendung von Verben in unseren Texten ist, desto besser für die Leser, uns und den Text.

7. Typo und Interpunktion

Dieser Abschnitt verdankt seine Existenz einem Leser des ersten Artikels — danke Mischa!

Lesbarkeit und auch Verständlichkeit eines Textes hängt auch von der korrekten Verwendung von Satzzeichen ab. Dies ist einerseits eine Frage der Zeichensetzung – also der Interpunktion – andererseits auch eine Frage des Schriftsatzes – d.h. der Typographie. Erstere regelt das 'wo', 'was' und 'wann'; letztere das 'wie', denn nicht immer haben wir die vollen Möglichkeiten des klassischen Buchdrucks zur Verfügung.

Interpunktion wurde bereits im ersten Artikel angeschnitten, auf dieses Thema wird also nicht näher eingegangen. Für Leser mit Wunsch nach näherer Information zu diesem Thema sei wieder auf das exzellente Buch 'Deutsch für Profis' von Wolf Schneider verwiesen.

Was das 'wie' der Zeichensetzung angeht, so haben wir heute Probleme, die in der Zeit vor dem Computer nicht existierten: Zeichensätze, speziell ASCII. ASCII ist der kleinste gemeinsame Nenner für (West-)Europäische Alphabete. Vergleichen wir einen ASCII-Zeichensatz mit modernem Unicode — oder dem Setzkasten eines Buchdruckers vor weniger als hundert Jahren — so stellen wir fest daß wir in der Zeichenanzahl stark eingeschränkt sind.

ASCII unterscheidet zum Beispiel nicht zwischen:

Trennstrich--
Bindestrich–
Gedankenstrich—

Der Trennstrich wird am Zeilenende bei Silbentrennung verwendet. Der Bindestrich kommt in zusammengesetzten Worten zum Einsatz, der Gedankenstrich setzt eingeschobene Gedanken vom Hauptsatz ab.

Genauso gibt es in ASCII kein Äquivalent zu den Auslassungspunkten ('Ellipsis', dargestellt durch drei Punkte mit geringerem Abstand, Unicode 8230). Wenn wir ein Office-Paket oder TeX verwenden, so ist diese Beschränkung kein Problem. In HTML oder in unformatierten Textdateien die einem Programm mitgegeben werden ist das jedoch mitunter ein Problem für uns und unsere Leser. In HTML kann man laut Standard — so es vom Browser unterstützt wird darstellen — jedoch kann das nicht jeder Browser.

Ähnlich ist die Situation bezüglich anderer Satzzeichen. Wenn wir möglichst nahe am kleinsten gemeinsamen Nenner bleiben wollen, müssen wir leider Abstriche an der typographischen Qualität unserer Texte machen.

7. Eine Frage der Zeit

Die Verwendung von Zeitformen sollte möglichst in sich konsistent bleiben:

In technischen Texten ist es die Gegenwart, die zählt.

In technischen Texten ist eine einheitliche Verwendung von Zeitformen wichtig; speziell die Gegenwartsform, denn vergangene Entwicklungen sind selten Gegenstand technischer Artikel. Futur ist ebenfalls nur selten notwendig, da wir ja etwas bestehendes beschreiben und nicht über künftige Entwicklungen spekulieren. Ganz generell: je weniger Zeitformen, desto klarer wird der Text.

8. Terminologie

Die Verwendung von technischem Fachvokabular sollte korrekt und in sich schlüssig sein. Wenn man sich einmal für eine Schreibeweise — und sei sie falsch — entschieden hat, so sollte man bei ihr bleiben. Richtige Schreibung ist natürlich besser, aber wenn, dann sollte man zu seinen Fehlern stehen.

Hier eine Liste korrekter Schreibweisen häufig vorkommender (meist englischer) Fachworte:

Clipart
Clipboard
Desktop
drop-down (Adjektiv)
Einheiten:
bpsBits pro Sekunde (baud)
GHzGigahertz
HzHertz
KBKilobyte
KbKilobit
KbpsKilobit pro Sekunde (Kbaud)
KHzKilohertz
MBMegabyte
MbMegabit
msMillisekunde
Was die 'Kilo'–einheiten angeht, so sollte man sich von Anfang an festlegen ob man dezimale '1000' oder binäre '1000' meint. Im letzteren Fall heißt 1000 in Dezimal umgerechnet 1024. Wenn wir auf dieser Basis weiterrechnen, weichen dezimale und binäre Größenangaben schnell stark von einander ab. Die IEC (Norm IEC 60027-2) und andere Normenorganisationen haben zur Unterscheidung vorgeschlagen, die binäre Variante entweder durch die Bezeichnung 'Kibobyte' (abgekürzt KiB) oder durch kB (vergleiche mit Kb!) zu kennzeichen. Dieser Vorschlag hat bisher wenig Anhänger gefunden.
NetNetzwerk
.NET/.netDie Microsoft–technologie, konsequent die eine oder die andere Schreibweise verwenden.
online/offlineOhne Bindestrich!
PostScript
ToolTip
TrueType

Schlußbemerkung

Das wars! Mit den Tips aus diesen zwei Artikeln und mit ein wenig Übung wirst Du, geneigter Leser, eine erfolgreiche und befriedigende Karriere im technischen Schreiben vor Dir haben. Viel Spaß und Erfolg!

Literatur

Wolf Schneider: Deutsch für Profis, Goldmann Verlag - Ein absolutes Muß für jeden der beruflich schreibt. Gut geschrieben, rein auf Praxis orientiert - der langjährige Chefredakteur des 'Stern' weiß wovon er schreibt.

Verwandte Artikel

Schreib"kunst" für Programmierer, Teil I

Links zu anderen Sites

Anglizismen und Übersetzungsfallen
Binäre Kilobyte–definition

Wenn Sie jetzt Fragen haben...

Wenn Sie Fragen rund um die in diesem Artikel vorgestellte Technologie haben, dann schauen Sie einfach bei uns in den Community Foren der deutschen .NET Community vorbei. Die Teilnehmer helfen Ihnen gerne, wenn Sie sich zur im Artikel vorgestellten Technologie weiterbilden möchten.

Haben Sie Fragen die sich direkt auf den Inhalt des Artikels beziehen, dann schreiben Sie dem Autor! Unsere Autoren freuen sich über Feedback zu ihren Artikeln. Ein einfacher Klick auf die Autor kontaktieren Schaltfläche (weiter unten) und schon haben Sie ein für diesen Artikel personalisiertes Anfrageformular.

 

Und zu guter Letzt möchten wir Sie bitten, den Artikel zu bewerten. Damit helfen Sie uns, die Qualität der Artikel zu verbessern - und anderen Lesern bei der Auswahl der Artikel, die sie lesen sollten.

Bewerten Sie diesen Artikel
 Sehr gut   Nicht genügend  
   1  2  3  4  5  
 

  
   Für Ausdruck optimierte Seite

©2000-2006 AspHeute.com
Alle Rechte vorbehalten. Der Inhalt dieser Seiten ist urheberrechtlich geschützt.
Eine Übernahme von Texten (auch nur auszugsweise) oder Graphiken bedarf unserer schriftlichen Zustimmung.