DE-Klient-Dokumentation-Stilr...

We Try Harder

Vorlage: Klient-Dokumentation Stilrichtlinien (in Arbeit)
Anwendbar für Deutsche Textübersetzungen nach US-Englisch (DE>EN-US)

Klient-Dokumentationsprojekt gemäss EN-15038:2006 (D)

Deutsche Quelltextversion

* Bitte beachte Wikipedia links, URL dieser Webseite: http://docs.google.com/Doc?id=dg9xxrf5_71dvzcnc

Bitte als Kollaborator bei Google Docs einloggen, oder Web2PDF Online bzw. Web2Doc für Ausdrucke verwenden.

Nach Deutschland: Mo - Fr 8:00 - 18:00 weltweit, Fax+Voice-To-Email: +49-1212-510437727

Anklicken zwecks Login-Prozess zur Desktop-Kollaboration

Ausschlussklausel

Deusch: TODO

English: Every effort has been made to ensure that the information compiled in this publication is accurate and correct. However, this does not guarantee complete accuracy. Neither the Client, the authors, nor translators shall be held liable for possible errors or the consequences thereof. Some of the software and hardware descriptions cited in this publication may from time-to-time be registered trademarks. Names of products and trademarks and trade protection laws and may thus fall under copyright restrictions. All trade names are subject to copyright restrictions and are registered trade marks of their respective owners. In citation of such names, the Client, and contributing members of the Client Documentation Project essentially adhere to the manufacturer's spelling and in no way make claim to them.

DEUTSCH: TODO

ENGLISH: THIS DOCUMENTATION IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Lizenzen

Deutsch: TODO

Endlish: This document is made available under a dual license strategy that includes the GNU Free Documentation License (GFDL) and the Creative Commons ShareAlike 2.0 License (CC-BY-SA). You are free to modify, extend, and improve the Client documentation source code under the terms of these licenses. All derivative works must be released under either or both of these licenses. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE AS DESCRIBED IN THE DISCLAIMER. Copies of these licenses are available in the appendices section of this book. Online versions can be found
at the following URLs: GNU Free Documentation License Attribution-ShareAlike 2.0

Revisionshistorie

Revision 0.1 2007.07.01 james.oreilly@web.de
DE-Klient-Dokumentation-Stilrichtlinien http://docs.google.com/Doc?id=dg9xxrf5_71dvzcnc (Deutsche Quelltextversion)
EN-US-Client-Documentation-Style-Guide http://docs.google.com/Doc?id=dg9xxrf5_70dvvs63 (US-Englisch Zieltextversion)
Anfangsversion der Stilvorschriften Vorabfreigabe
Inhalt hinzugefügt: Kapitel x.x
Erste Freigabeversion

Kurzfassung

Stilrichtlinien für ein Klient-Dokumentationsteam. Das Handbuch für Klient-Dokumentation Stilrichtlinien wurde unter Mitwirkung der Teilnehmern des Klient-Dokumentationsteams aufgebaut, und representiert die derzeit-akzeptierte sprachliche Vorgehensweise bei der Erstellung und Pflege von Dokumenten (Quelltexte) durch das Team, allerdings in Kontext mit der Übersetzbarkeit des deutschen Quelltextes in US-Englischer Sprache (Zieltext). Es wird ebenfalls auf die US-Englisch Zieltextversion dieses Handbuchs verwiesen. Ein Paar Einzelheiten fehlen noch im Handbuch (markiert mit TODO).

Inhaltsverzeichnis

Vorwort

Danksagung

1. Einführung

1.1 Übersicht über die Stilrichtlinien
1.2 Anwendbarkeit und Vorrang der Stilrichtlinien

2. Informationsdesign

2.1 Scannerfreundlich Schreiben
2.2 Schreibstil Mit Dokumentationszweck und Zielaudienz Abgleichen
2.3 Formatierung Mit Inhaltsprioritäten Abgleichen

3. Grammatik, Zeichensetzung und Buchstabierung

3.1 Grammatik und Deutsch
3.2 Zeichensetzung
3.3 Apostroph
3.4 Doppelpunkt
3.5 Komma
3.6 Bindestrich
3.7 Klammern
3.8 Satzende
3.9 Ausrufezeichen
3.10 Strichpunkt
3.11 Buchstabierung

4. Liste von Häufigen Wortverwechslungen

5. Schreiben für ein Internationaler Audienz

5.1 Universalität von Beispielen
5.2 Verwendung von Zahlen und Bildern
5.3 Verwendung Korrekter Terminologie
5.4 Kulturelle Erwägungen

6. Wortliste

7. Referenzmaterial
        7.1 Computer-bezogene Referenzen
        7.2 Allgemeine Schreibreferenzen
        7.3 Stilrichtlinien EN-15038:6000 (D) Anhang D (informativ)

Nach oben

Vorwort

Nach oben

Danksagung

Nach oben

1. Einführung

Nach oben

1.1 Übersicht über die Stilrichtlinien

Nach oben

1.2 Anwendbarkeit und Vorrang der Stilrichtlinien

Nach oben

2. Informationsdesign

Nach oben

2.1 Scannerfreundlich Schreiben

Nach oben

2.2 Schreibstil Mit Dokumentationszweck und Zielaudienz Abgleichen

Nach oben

2.3 Formatierung Mit Inhaltsprioritäten Abgleichen

3. Grammatik, Zeichensetzung und Buchstabierung

Nach oben

3.1 Grammatik und Deutsch

Nach oben

3.2 Zeichensetzung

Nach oben

3.3 Apostroph

Nach oben

3.4 Doppelpunkt

Nach oben

3.5 Komma

Nach oben

3.6 Bindestrich

Nach oben

3.7 Klammern

Nach oben

3.8 Satzende

Nach oben

3.9 Ausrufezeichen

Nach oben

3.10 Strichpunkt

Nach oben

3.11 Buchstabierung

Nach oben

4. Liste von Häufigen Wortverwechslungen

Nach oben

5. Schreiben für ein Internationaler Audienz

Nach oben

5.1 Universalität von Beispielen

Nach oben

5.2 Verwendung von Zahlen und Bildern

Nach oben

5.3 Verwendung Korrekter Terminologie

Nach oben

5.4 Kulturelle Erwägungen

Nach oben

6. Wortliste

Nach oben

7. Referenzmaterial

Andere Stilrichtlinien und dergleichen:

7.1 Computer-bezogene Referenzen

Kategorie: Wikipedia Styleguide http://de.wikipedia.org/wiki/Kategorie:Wikipedia:Styleguide

Gnome Documentation Style Guide
http://developer.gnome.org/documents/style-guide/

The KDE Style Guide
http://i18n.kde.org/doc/styleguide/index.html

The KDE DocBook Author's Guide
http://i18n.kde.org/doc/markup/index.html

LDP Author Guide
http://www.tldp.org/LDP/LDP-Author-Guide/html/index.html

Fedora Project Documentation Guide
http://fedora.redhat.com/participate/documentation-guide/

NASA Grammar, Punctuation, and Capitalization: A Handbook for Technical Writers and Editors
http://stipo.larc.nasa.gov/sp7084/index.html

O'Reilly Default Stylesheet and Word List
http://www.oreilly.com/oreilly/author/stylesheet.html

Ubuntu Documentation Project
http://doc.ubuntu.com/styleguide/styleguide.html

Nach oben

7.2 Allgemeine Schreibreferenzen

Online Writing Lab
http://owl.english.purdue.edu/

7.3 Stilrichtlinien EN-15038:2006 (D) Anhang D (informativ)

Im Rahmen von Stilrichtlinien können unter anderem folgende Vorgaben gemacht werden:

Interpunktion: Leerzeichen, Punkte, Kommas, Semikolons, Doppelpunkte, Gedankenstriche, Klammern (rund und eckig), Fragezeichen, Ausrufezeichen, Anführungs- und Schlusszeichen, Apostrophe, Akzente, UNICODE-Zeichen und ASCII-Zeichen;
Schreibweise: Groß- und Kleinschreibung, Konventionen, Personennamen und -titel, geografische Bezeichnungen, Firmen- und Produktnamen, Marken, wissenschaftliche Bezeichnungen, Zahlen (Brüche, Bereiche, römische Ziffern, Datum, Zeit) und Maßeinheiten, mathematische und andere wissenschaftliche Symbole, Abkürzungen und Akronyme, Entlehnungen (Wörter und Phrasen aus anderen Sprachen), Silbentrennung, Komposita, Bindestrichverwendung, Transliteration, Umschreibung ins lateinische Alphabet;
Formatierung, Schriftauszeichnung und Schriftart: Rundschrift, Fettdruck, Kursivschrift, Unterstreichungen, Schriftarten, allgemeine Symbole (z. B. ©, ®, &, %, tm, #);
Sonstiges: Auflistungen und Tabellen, Papierformat, geschlechtsneutrale Sprache, Tempora, Fußnoten, Quellenverzeichnisse/Literaturhinweise, Zitate, Schaubilder, Grafiken und Illustrationen, Übersetzung von Tags und Attributen;
Konventionsbedingte Anpassungen: Kulturspezifische Ausdrücke und Sachverhalte, Anrede, Stammdaten (Preis, Angebote, Postanschrift, E-Mail-Adresse, Fax- und Telefonnummer usw.), Umrechnung von Währungen und Maßeinheiten, kulturbezogene Grafikelemente und andere Kulturspezifika;
Bei der Lokalisierung von Software: Bezeichnungen von Tasten, morphosyntaktische Konventionen für Komponenten von Benutzeroberflächen: Menüs, Dialogfenster, Fehlermeldungen;
Terminologische Festlegungen, kontrollierte Sprache, Regeln gegen bestimmte Ausdrucksweisen, sprach und kundenspezifische Präferenzen;
Vermeidung gängiger Übersetzungsfehler (z. B. Faux amis, urverwandte Wörter, Sprachinterferenzen, falsches Sprachregister usw.).