1 Über dieses Dokument1.1 ZielsetzungIn diesem Styleguide sollen einige Grundregeln für die Gestaltung der im deutschen OpenOffice.org Projekt erstellten Dokumente definiert werden. Es soll sichergestellt werden, dass Dokumente einheitlich gestaltet sind und eine weitere Bearbeitung durch andere Mitglieder vereinfacht wird. Der vorliegende Styleguide bezieht sich auf Druckdokumente und ist nicht ohne diverse Anpassungen für Onlineveröffentlichungen geeignet. Dieser Styleguide ist eine Empfehlung! Der Inhalt ist wichtiger als die Form. Der Styleguide soll eine Arbeitserleichterung bieten, um Dokumente zu erstellen. Dazu dienen die auf diesem Styleguide basierenden Dokumentvorlagen. 1.2 AnwendungDokumente sollten stets mit OpenOffice.org erstellt werden, da dann Dokumentvorlagen genutzt werden und Formate auch nachträglich zentral geändert werden können. Werden Dokumente mit einer anderen Software erstellt, sollten die Formatvorschläge unter 6 umgesetzt werden. Es werden folgende Dateien als Arbeitserleichterung zur Verfügung gestellt.
Tabelle 1: Arbeitsmittel zum Styleguide Um die Richtlinien hinsichtlich Rechtschreibung und Begriffen einzuhalten, sollte mit eingeschalteter Rechtschreibprüfung gearbeitet werden. Oft benötigte Begriffe können in der Autokorrektur definiert werden (z.B. OOo -> OpenOffice.org). 1.3 Änderung des StyleguidesDieser Styleguide deckt sicherlich nicht alle Belange ab, die bei der Erstellung von Dokumentationen zu beachten sind. Änderungen und Ergänzungen werden über das deutsche OpenOffice.org Projekt eingearbeitet. Dazu ist ein Issue mit der Beschreibung (Summary) „Erweiterung Styleguide“ für die Komponente „de“ zu eröffnen. Der Issue kann direkt einem der Autoren (siehe 7 Autoren) zugewiesen werden (Feld „Assigned to“). Alternativ können die Autoren auch nachträglich informiert werden (Feld „Add cc“). Bedenken Sie aber, dass das Team wechselt, einzelne Mitglieder also evtl. nicht zur Verfügung stehen. 1.4 Was ist noch zu tunDer Styleguide muss noch anhand der zu bereits vorhandenen Dokumentationen geprüft werden. Folgende Fragen stehen z.B. noch offen:
2 Sprache, Rechtschreibung, Textgestaltung2.1 Ausdrucksstil
2.2 RechtschreibungNeue deutsche Rechtschreibung verwenden, im Zweifelsfall die Rechtschreibprüfung zu Hilfe nehmen oder unter www.neue-rechtschreibung.de prüfen. Das „ß“ nicht nutzen, wo es nicht hingehört. Werden Wörter von Hand getrennt, nur weiche Trennungen verwenden (<Strg>+<->), um zu vermeiden, dass bei Änderungen keine Wörter mit Trennzeichen mitten in der Zeile stehen (z.B. Trenn-zeichen). 2.3 Kennzeichnung von Schlüsselwörtern, DialogelementenUm Schlüsselwörter, Tastenkombinationen, Dialogelemente u.ä. klar zu kennzeichnen, werden eine einheitliche Notationsweise und spezielle Zeichenvorlagen für die Hervorhebung benutzt. In der folgenden Tabelle sind in den Hinweisen zur Notation mit Leerzeichen immer geschützte Leerzeichen ( <Strg>+<Leerzeichen> ) gemeint.
Tabelle 2: Hervorhebungen 2.4 Tipps und systemspezifische HinweiseTipps, die besondere Aufmerksamkeit verdienen bzw. eine Zusammenfassung einer längeren Textpassage darstellen, werden durch ein Symbol am linken Textrand gekennzeichnet. Der Text selbst wird entsprechend eingerückt und grau hinterlegt. Erklärungen, die nur auf ein bestimmtes Betriebssystem zutreffen werden auf die gleiche Art gekennzeichnet.
Die hier gezeigte Darstellung wird durch einfügen einer Tabelle erreicht. Der Tabelle wird das Autoformat „Ooo Hinweis“ zugewiesen. Nachträglich muss die Breite der ersten Spalte auf 1,30cm gestellt und die vertikale Textausrichtung in Spalte 1 auf „Mitte“ gestellt werden. Das Symbol erhält die Rahmenvorlage „Hinweissymbol“. Um die Trennung vom normalen Text zu wahren, wird der obere und untere Abstand auf 12pt gesetzt.
3 Formatierung3.1 Grundregeln
3.2 FarbenFarben haben einen hohen Wiedererkennungswert und sind ein gutes gestalterisches Mittel. Trotzdem sollte nur eine begrenzte Farbpalette sparsam eingesetzt werden. Der großflächige Einsatz von Farben (z.B. farbige Flächendiagramme über eine ganze Seite) sollte vermieden werden. Farben sollten nie als alleiniges Mittel zur Unterscheidung von Inhalten genutzt werden. Die Dokumente werden oftmals privat auf schwarz-weiß Druckern ausgedruckt.
Tabelle 3: Farbtabelle 3.3 Formatvorlagen und deren Bedeutung
Tabelle 4: Formatvorlagen Werden in einem Dokument zusätzliche Formatierungen verwendet, sollten diese eine eindeutige Bezeichnung erhalten und im Dokument erwähnt werden bzw. in diesen Styleguide einfließen. 4 Umgang mit Dokumenten4.1 Einbinden von Grafiken
4.2 Erstellen von Screenshots
4.3 Positionieren von Grafiken
4.4 Einbinden von Objekten
4.5 Einbinden von OpenOffice.org DokumentenDieser Abschnitt sollte geschrieben werden, sobald benötigt. 4.6 Richtlinien für GliederungenEs sollten enthalten sein:
Je nach Größe des Dokumentes können einige Punkte entfallen. 5 Glossar5.1 Grundregeln für Begriffe
5.2 BegriffslisteDie hier vorgestellte Begriffsliste ist eine Orientierungshilfe, keineswegs komplett
Tabelle 5: Begriffsliste 6 Formatvorschläge6.1 SchriftartenDie Verwendung von Schriftarten wird durch die unter 3.3 definierten Formatvorlagen geregelt.
6.2 FormatvorschlägeZur Verwendung der Vorlagen siehe 3.3.
Tabelle 6: Formatvorschläge 7 AutorenAndre Schnabel (AndreSchnabel@openoffice.org) Christian Lohmaier (cloph@openoffice.org) Rene Lemke (RLemke@openoffice.org) Tobias Sager (tsager@openoffice.org) |
The free and open productivity suite
- Search
-
Change Language
OpenOffice.org is available in many different languages. You might want to visit the webpages created by one of our many native language communities.
-
Log In
und Achtung
zur Verfügung.
,
Solaris
,
Unix
und Windows
zur Verfügung
