DDPs dokumentationsriktlinjer

Den här manualen är rätt så gammal men det pågår arbete på att uppdatera den på sändlistan debian-doc. Se det aktuella utkastet till nya riktlinjer.

Här följer en lista över beslut som tagits på vår sändlista och som godkänts av vår dokumentationschef, 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.
Observera att detta inte betyder att man måste lära sig SGML 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 i Debian-Doc-gruppen.
De andra alternativen var: LaTeX, HTML, Texinfo, och flera andra mindre format.
Vi använder debiandoc-sgml för våra dokument.
De andra alternativen var linuxdoc-sgml eller DocBook. Linuxdoc underhålls inte längre; DocBook anses av många vara för stor och komplex, och svår att skräddarsy.
Alla Debiandokument kommer att ha en person listad som Ansvarig (Maintainer), och kan även ha andra personer listade som Medansvariga (Co-Maintainers).