Deutsch:

Die freie und offene Büro-Software
Apache OpenOffice 4.1.1 ist verfügbar!

FAQs – Stil-Richtlinien

Zuletzt bearbeitet am: 15. Dezember 2001 von cloph

Zusammenfassung

Hier werden Richtlinien beschrieben, welche ein annähernd einheitliches Aussehen der deutschsprachigen Dokumentation gewährleisten sollen. Diese Richtlinien sind keineswegs als „in Stein gemeißelte Gesetze“ zu verstehen, sondern eher einen Anhaltspunkt darstellen.

Wer Verbesserungsvorschläge oder anderweitige Kommentare hierzu hat, wende sich bitte an die Mailingliste des Projekts lang/de. Wie das geht wird unter http://de.openoffice.org/ beschrieben.

Richtlinien

  • Dateien durchnumerieren (001.html, 002.html und so weiter); in jedem Unterordner wieder bei 001.html beginnen

  • Schriftart für Überschriften oder Fragen: Arial, fett

  • Schriftart für Antworten: Arial, normal

  • Schriftart für Befehle, Pfadangaben oder ganze Beispiele: Courier, normal

  • Die Schriftgröße kann variiert werden

  • Bullet-Listen oder Numerierungen für Befehlsschlangen oder umfangreichere Abläufe

  • Seiten in „Plain HTML“ (ohne Applets, Skripte und ohne Grafiken – Ausnahmen sind das OO.o-Logo und Icons oder Screenshots, welche zum besseren Verständnis der Antworten beitragen)

  • Schreibweise für Menüeinträge: fett und durch '-' getrennt
    Beispiel: Menü-Eintrag

Was man tun sollte und was nicht

  • Unnötige Höflichkeitsfloskeln wie z.B. „Bitte öffnen Sie...“ vermeiden - anstattdessen einfach „Öffnen Sie...“ schreiben

  • Technische Abläufe mit Hilfe von Aufzählungen beschreiben anstatt die Anweisungen in Sätze zu packen, welche sich dann schwer lesen lassen.
    Beispiel:

    • Mache das

    • und dann das

    • dann sieht man folgendes

    • und es passiert jenes

  • Die Antworten mit einer „Prise Humor“ würzen ;-)

Valid XHTML 1.0 Transitional

Apache Software Foundation

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.