DDPs dokumentationsriktlinjer

Den här manualen är rätt så gammal men det pågår ett ofullständigt arbete med att uppdatera den på sändlistan debian-doc. Se det aktuella utkastet till nya riktlinjer. För alla nya bidrag rekommenderas att DocBook XML används istället för debiandoc-sgml.

Här följer en lista över beslut som tagits på vår sändlista och som godkänts av projektmedlemmarna och vår tidigare dokumentationschef (som har avgått), Susan G. Kleinmann.

Alla manualer i Debian Documentation Project kommer att släppas under licenser som överensstämmer med DFSG, oftas GPL.

Vi använder följande katalogstruktur:

Filsystem:

  /usr/share/doc/manuals/någonmanual/index.html
  /usr/share/doc/manuals/någonmanual.ps.gz (valfri)

Webbserver:

  http://www.debian.org/doc/manuals/någonmanual/

FTP-server:

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

Observera att denna del av policyn inte har accepteras överallt ännu, så dessa URIer kanske inte fungerar. De riktiga platserna kan variera på grund av bakåtkompatibilitet.

Vi använder SGML som källkodsformat för våra dokument, allra helst Docbook XML.
Observera att detta inte betyder att man måste lära sig SGML eller XML för att sända in ändringar till våra dokument, vi accepterar även andra format. De kommer dock att översättas till SGML av någon av medlemmarna i gruppen.
Notera att några äldre dokument som hålls aktuella av gruppen fortfarande är i formatet debiandoc-sgml. Dessa håller på att översättas, i mån av tid, till dokument av typen DocBook XML. Formatet debiandoc-sgml anses vara föråldrat.
De andra alternativen var: LaTeX, HTML, Texinfo, och flera andra mindre format.
Vi underlättar för översättarna genom att använda PO.
Genom att använda po4a-verktygen ser vi till att översättare som vill följa översättningar med hjälp av PO-formatet ges verktyg för att göra det.
Alla Debiandokument kommer att ha en person listad som Ansvarig (Maintainer), och kan även ha andra personer listade som Medansvariga (Co-Maintainers).