Blender Dokumentation: Richtlinien

Aus Wikibooks
Wechseln zu: Navigation, Suche
<<<Zurück
Projektdefinition
Inhaltsverzeichnis

Handbuch durchsuchen

Weiter>>>
Dokumentations-Vorlagen



Sie werden hier gebraucht!

Die Übersetzung, Erneuerung und Erweiterung des Blender-Handbuches ist aufwändig, daher ist die Mithilfe von vielen Menschen gewünscht. Sie können an vielen Stellen und auf unterschiedlichem Niveau helfen (die folgende Auflistung ist nach zunehmendem Kenntnisgrad geordnet):

  • Verbessern von Rechtschreib- und Grammatikfehlern
  • Korrigieren falscher oder toter Links
  • Lektorat von fertigen, neuen Artikeln Letzte Änderungen:
    • Wie verständlich ist der Artikel?
    • Ist er sprachlich stimmig oder eher holprig formuliert?
    • Gibt es genug Bilder/Beispiele? Stellen sie die Sachverhalte erkennbar dar?
  • Eintragen von unvollständigen/veralteten/unzureichenden Artikeln in die ToDo-Liste.
  • Bearbeitung von noch nicht fertiggestellten Artikeln: ToDo-Liste
  • Erstellung von noch nicht angefangenen Artikeln in Anlehnung an das englischsprachige Handbuch.
  • Bei der Diskussion um die Struktur des Inhaltsverzeichnisses.
  • Erstellung von Teilen, die im englischsprachigen Handbuch fehlen.

Diese Handbuch soll keine reine Funktionsauflistung werden. Es sollten vielmehr Konzepte erläutert werden, und wie man diese umsetzt. Dazu gehören Beispiele und Bilder. Das Handbuch soll nach Möglichkeit visuell ansprechend werden.

Erste Schritte[Bearbeiten]

  1. Melden Sie sich bei Wikibooks an (Anmelden).
  2. Suchen Sie sich einen Link von der ToDo-Liste aus, bei dem Sie den Eindruck haben, etwas zum Thema beitragen zu können.
  3. Bearbeiten Sie den Artikel, oder schreiben Sie Änderungsvorschläge auf die Diskussionsseite des Artikels.
  4. Wenn Sie an der Blender Dokumentation mitarbeiten und größere Änderungen vornehmen wollen, setzen Sie sich bitte vorab mit Soylentgreen in Verbindung auf seiner Benutzerseite .
  5. Dies gilt in besonderem Maße, wenn Sie das Inhaltsverzeichnis ändern bzw. durch neue Artikel ergänzen wollen.

Sie können im Moment auch sehr helfen, wenn Sie das Glossar erweitern, damit dort eine Funktionsübersicht mit Links auf die entsprechenden Handbuchseiten entsteht.

  • Es gibt (wie immer im Leben) Regeln, von denen einige eingehalten werden müssen. Informationen darüber finden Sie in den folgenden Abschnitten auf dieser Seite.
  • Es gibt eine Seite mit Dokumentations-Vorlagen, die Ihnen die Arbeit erleichtern sollen.
  • Bestimmte Fachbegriffe werden übersetzt. Für (leider noch zu wenige) Begriffe gibt auf der Seite Übersetzungen Vorschläge. Können Sie gut Englisch und kennen sich im 3D-Bereich aus? Ergänzen Sie die Übersetzungsliste!

Bilder[Bearbeiten]

  • Alle Bilder sollten auf jeden Fall auf Wikimedia-Commons hochgeladen werden. Folgen Sie zunächst dem Link Hochladen, und dann auf Commons hochladen. Dort werden in einer Reihe von Feldern alle Eingaben abgefragt. Um die vorgefertigen Lizenzbausteine zu benutzen, benutzen Sie das alte Formular.
  • Dazu müssen Sie leider auf Wikimedia-Commons einen weiteren Benutzeraccount anlegen. Wenn Sie bereits einen Account auf Wikipedia haben, können Sie einen Unified-Account auf Commons benutzen (sofern der Benutzername noch frei ist).
  • Alle Bilder werden Blender3D_Name_des_Bildes benannt, der Teil Blender3D ist verbindlich.
  • Sinnvolle Bildbeschreibungen auf Commons mit passender Lizenz habe ich auf der Seite Commons-Lizenzen bereitgestellt.
  • Um die Seiten leichter ausdrucken zu können, sollten Bilder folgende Anforderungen erfüllen:
    • Screenshots aus dem 3D-Fenster sollten - außer bei einer Einführung für absolute Anfänger - einen weißen Hintergrund haben.
    • Bilder sollten eine Breite von 700px nicht überschreiten.
    • Animationen sollten keine Informationen enthalten, die nicht auch aus dem Text entnehmbar sind.

Formatierung[Bearbeiten]

  • Für das Layout wurde eine Beispielseite erstellt, deren Layout übernommen werden sollte. Testseite für das Layout.
  • Auf der Seite Dokumentations-Vorlagen finden Sie verschiedene Codebeispiele zum kopieren.
  • Tastaturkombinationen werden einfach fett hervorgehoben, z.B. A oder Strg-T, wobei Strg gemischt groß- und kleingeschrieben wird. Tasten werden also im Unterschied zur englischsprachigen Vorlage nicht mit XKEY benannt. Die Tasten werden wie auf der deutschen Tastatur beschriftet.
Space, Return, Shift, Esc, Num, Hoch, Runter, Rechts, Links.
Für die Hervorhebung existiert auch eine Vorlage {{:Blender3D:_Vorlage:KEY|Taste}}. Taste
  • Menüpunkte werden kursiv geschrieben, Folgen von Menüpunkten wie im Original durch >> oder -> getrennt, z.B. Space>>Add>>Mesh>>Cube, dabei sollten die englischen Menütexte inklusive der Groß- und Kleinschreibung übernommen werden.
  • gleiches gilt für Begriffe wie Edit Buttons
Auch hier existiert eine Vorlage: {{:Blender3D:_Vorlage:Literal|Begriff}}.

Externe Links[Bearbeiten]

Das Handbuch ist keine Linksammlung, außerdem ist es in deutscher Sprache geschrieben. Okay sind:

  • Links zum englischsprachigen Original des Handbuchs
  • Links zu den Release-Notes
  • Links zu überragend guten Beispielen
  • Links zu guten, aktuellen deutschsprachigen Tutorials

Nicht notwendig sind:

  • Links zu jedem verfügbaren (Kurz)tutorial
  • Links zu englischsprachigen Tutorials

Nicht okay sind:

  • Links zu Seiten die mit Blender nichts zu tun haben. Ausnahme können Fachbegriffe sein, deren Erläuterung sehr umfangreich ist und die im Wikibuch beschrieben sind. Beispiel: der YUV Farbraum.

Fortschrittsanzeige[Bearbeiten]

Seiten die überarbeitet werden müssen, werden in die ToDo-Liste gestellt, und dort mit ihrem Status markiert (Icons 1von10.png bis 9von10.png ([[Bild:1von10.png]] usw.)).

Wird eine Seite fertiggestellt, wird Sie von der ToDo-Liste auf Letzte Änderungen verschoben und ganz oben eingetragen. Nach angemessener Zeit werden die Einträge am unteren Ende der Liste entfernt.

Namenskonventionen - Anlegen neuer Seiten[Bearbeiten]

  • Neue Seiten werden durch das Anlegen eines Links auf einer existierenden Seite erzeugt, der Link wird dann zunächst rot dargestellt.
[[Blender Dokumentation: Seitentitel|Linktext]]
Blender3D FreeNote.gif

Der Teil Blender Dokumentation: ist verbindlich.


  • Im Anhang bei den Tutorials werden die Seiten durch Schrägstriche, gefolgt von einem Leerzeichen getrennt. Dies ermöglicht eine automatische erstellte Navigation.

Neue Versionen[Bearbeiten]

Die Blenderentwicklung ist im steten Fluss. Etwa jedes halbe Jahr kommt eine neue Version heraus. Nicht jeder ist jedoch in der Lage, sich sofort die neueste Version zu installieren, bspw. Nutzer in Firmen und Schulen.

Daher sollen bei einem Update der Dokumentation die alten Seiten unverändert erhalten bleiben.

Folgende Vorgehensweise soll angewandt werden:

  • Wenn eine Seite auf eine neue Blenderversion aktualisiert werden soll, muss die alte Seite unter dem Namen "Blender Dokumentation: NameDerSeite VersionsNummer" gesichert werden. Dazu legen Sie eine neue Seite an, und kopieren den gesamten Inhalt der alten Seite auf die neue Seite.
Ein Beispiel: "Blender Dokumentation: Raytracing Transparenz 2.37a"
Und wieder das Beispiel: {{:Blender3D:_Vorlage:Version_hist|2.40|[[Blender Dokumentation: Raytracing Transparenz 2.37a|2.37a]]}}
  • Wenn Bilder (Screenshots) aktualisiert werden, müssen diese unter einem neuen Namen gespeichert werden, damit die ältere Seite in ihrer Gesamtheit erhalten bleibt.
  • Die Verlinkung aus dem Inhaltsverzeichnis zeigt immer auf die gleiche Seite und wird nicht geändert.

Sprache[Bearbeiten]

  • Bei direkter Anrede wird der Leser gesiezt, wobei das "Sie" bzw. "Ihr" als Possessivpronomen großgeschrieben werden.
  • Es gibt eine Seite mit Übersetzungen auf denen übersetzte Fachbegriffe eingetragen werden können. Ziel ist es bestimmte Begriffe im Buch einheitlich zu benutzten. Übersetzungen
  • Wichtige englische Begriffe werden in eckigen Klammern hinter die Übersetzung geschrieben, z.B. Gruppierung [Parenting]. Das gilt auch für den umgekehrten Fall, wenn man die deutsche Übersetzung hinter den englischen Begriff schreiben möchte, z.B. Parenting [Gruppierung].
  • Für aus dem Englischen übernommene Begriffe sollte ein Eintrag im Glossar angelegt werden, der den Begriff auch mit einer deutschen Übersetzung versucht zu erläutern. Es bleibt aber immer im Einzelfall abzuwägen, ob man einen Begriff übersetzt (der dann in der Programmoberfläche schwieriger wiederzufinden ist), oder bei der englischen Bezeichnung bleibt.



Blender Dokumentation
Dokumentations-Vorlagen
Testseite für das Layout
Übersetzungen

<<<Zurück

Projektdefinition

Inhaltsverzeichnis
Glossar
Weiter>>>

Dokumentations-Vorlagen