DDP Dokumentation-Regeln

Dieses Handbuch ist ziemlich veraltet, und es gibt auf der debian-doc-Mailingliste noch laufende Arbeiten, dies zu beheben. Lesen Sie dazu den aktuellen Entwurf der neuen Richtlinien. Für alle neue Beiträge wird die Verwendung von DocBook XML anstelle debiandoc-sgml empfohlen.

Hier ist eine Liste von Entscheidungen, die wir auf unserer Mailingliste getroffen haben und denen unsere Projektmitglieder und unsere damalige Dokumentations-Managerin, Susan G. Kleinmann, zugestimmt hat.

Alle Handbücher des Debian-Dokumentations-Projekts (DDP) werden mit einer DFSG-verträglichen Lizenz veröffentlicht, höchstwahrscheinlich der GPL.

Wir benutzen die folgende Verzeichnisstruktur:

Dateisystem:

  /usr/share/doc/manuals/einmanual/index.html
  /usr/share/doc/manuals/einmanual.ps.gz (optional)

Webserver:

  http://www.debian.org/doc/einmanual/

FTP-Server:

  http://ftp.debian.org/debian/doc/manuals/einmanual.html.tar.gz
  http://ftp.debian.org/debian/doc/manuals/einmanual.text.gz
  http://ftp.debian.org/debian/doc/manuals/einmanual.dvi.gz
  http://ftp.debian.org/debian/doc/manuals/einmanual.ps.gz
  http://ftp.debian.org/debian/doc/manuals/einmanual.sgml.tar.gz

Bitte beachten Sie, dass dieser Teil der Policy bis jetzt noch nicht universell akzeptiert wurde, daher könnten diese URIs nicht funktionieren. Die tatsächliche Position der Dokumente könnte aufgrund von Abwärtskompatibilität variieren.

Wir werden SGML als Quellformat für unsere Dokumente verwenden, bevorzug mit Docbook XML.
Beachten Sie, dass dieses nicht bedeutet, dass Sie SGML oder XML lernen müssen, um Änderungen an den Dokumenten einzureichen. Wir akzeptieren auch andere Formate. Sie werden allerdings von einem Mitglied der Gruppe nach SGML übertragen.

Bitte beachten Sie, dass einige ältere von der Gruppe betreuten Dokumente noch im Format debiandoc-sgml vorliegen. Diese werden, sofern Zeit dafür vorhanden ist, in DocBook-XML-Dokumente umgewandelt. Das Format debiandoc-sgml wird als veraltet betrachtet.

Die anderen Optionen sind: LaTeX, HTML, Texinfo, sowie verschiedene andere Formate.
Wir erleichtern die Arbeit der Übersetzer durch die Verwendung von PO.
Indem wir die po4a-Werkzeuge verwenden, stellen wir sicher, dass die Übersetzer, die ihre Übersetzung durch Einsatz des PO-Formats aktuell halten möchten, die geeigneten Werkzeuge dafür erhalten.
Jedes Debian-Dokument wird von einer einzigen Person als Betreuer gepflegt und kann verschiedene andere Personen als Co-Betreuer aufführen.