DDP Dokumentation-Regeln

Dieses Handbuch ist ziemlich veraltet, und es gibt auf der debian-doc Mailingliste Anstrengungen, dies zu beheben. Lesen Sie dazu den aktuellen Entwurf der neuen Richtlinien.

Hier ist eine Liste von Entscheidungen, die wir auf unserer Mailingliste getroffen haben und denen unsere 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 verwenden.
Beachten Sie, dass dieses nicht bedeutet, dass Sie SGML lernen müssen, um Änderungen an den Dokumenten einzureichen. Wir akzeptieren auch andere Formate. Sie werden allerdings nach SGML übertragen von einem der Debian-Doc-Leute.

Die anderen Optionen sind: LaTeX, HTML, Texinfo, sowie verschiedene andere Formate.
Wir werden debiandoc-sgml für unsere Dokumente benutzen.
Die anderen Optionen sind linuxdoc-sgml oder DocBook. Linuxdoc wird nicht länger gewartet; DocBook wurde von vielen als zu komplex und kompliziert zum Anpassen eingestuft.
Jedes Debian-Dokument wird von einer einzigen Person als Betreuer gepflegt und kann verschiedene andere Personen als Co-Betreuer aufführen.