Übersicht

Diese Seite beinhaltet die Gestaltungsrichtlinien für dtdocs und Informationen, wie an diesem Projekt mitgemacht werden kann.

Sie wird in das Benutzerhandbuch eingefügt, damit du sehen kannst, wie die Seite zusammengestellt wird und wie es geschrieben wird. Bitte gehe zu GitHub, um die Quelle für diese Seite zu sehen.

Die Struktur der Anleitung und der Inhalt wurden nach den folgenden Kriterien sorgfältig ausgewählt:

  1. Die Anleitung soll umfassend sein, d.h. sie sollte in darktable enthaltenen Funktionalität vollständig beschreiben.
  2. Sie sollte eine konsistente und logische Struktur haben und jeder Teil der Funktionalität soll seinen eigenen logischen Platz in dieser Struktur haben.
  3. Sie soll so lang wie nötig, aber so kurz wie möglich sein: Kürze ist ein Muss.
  4. Sie soll objektiv sein.
  5. Funktionalität sollen nur einmal erklärt werden (mit Ausnahme des grundsätzlichen Anleitung zum Arbeitsablauf in der Einführung).
  6. Bilder sollten nur verwendet werden, wenn dies der besseren Verständlichkeit der wesentlichen Prinzipien dient. Bilder sollten keinen Text enthalten, außer es ist unvermeidbar.

Wir sind grundsätzlich nicht interessiert an:

  1. Das Handbuch zu restrukturieren
  2. Markup Sprachen zu wechseln
  3. Detaillierte Tutorials zum Arbeitsablauf (obwohl wir interessiert daran sind, solche in Blogs entweder auf dartable.org oder pixls.us zu publizieren

We are interested in

  1. Spelling and grammar corrections
  2. Clarification of text
  3. Documentation for new features

Wir sind stark daran interessiert, zu hören, welche Abschnitte der Anleitung keinen Sinn ergeben und warum, sodass wir die Dokumentation verbessern können.

Generell ist vor größeren Änderungen ratsam, ein Ticket zu eröffnen und dieses zuerst mit den Betreuern zu diskutieren. Damit wird verhindert, dass investierte Arbeit später nicht akzeptiert wird.

🔗Der richtige Weg

Der bevorzugte Weg mitzuarbeiten ist durch Erstellung eines Pull-Requests. Siehe Arbeitsblauf für eine detaillierte Schritt-für-Schritt-Anleitung.

Wenn du dich damit nicht auskennst oder wohlfühlst, können Verbesserungen auch durch Eröffnung eines Github-Issue vorgeschlagen werden.

translations