DDP - dokumentoinnin menettelytavat

Tämä opas on melkoisen vanhentunut ja ponnistelemme asian korjaamiseksi debian-doc-postilistalla. Tuorein vedos dokumentista löytyy täältä.

Tämä on luettelo päätöksistä, jotka tehtiin postilistallamme ja jotka on hyväksynyt dokumentoinnin johtaja, Susan G. Kleinmann.

Kaikki Debian-dokumentointiprojektin (DDP) käyttöoppaat tullaan julkaisemaan DFSG:n mukaisen lisenssin alaisena, todennäköisimmin GPL:n alaisena.

Tulemme käyttämään seuraavanlaista hakemistorakennetta:

Tiedostojärjestelmä:

  /usr/share/doc/manuals/jokinkäyttöopas/index.html
  /usr/share/doc/manuals/jokinkäyttöopas.ps.gz (valinnainen)

WWW-palvelin:

  http://www.debian.org/doc/manuals/jokinkäyttöopas/

FTP-palvelin:

  http://ftp.debian.org/debian/doc/manuals/jokinkäyttöopas.html.tar.gz
  http://ftp.debian.org/debian/doc/manuals/jokinkäyttöopas.text.gz
  http://ftp.debian.org/debian/doc/manuals/jokinkäyttöopas.dvi.gz
  http://ftp.debian.org/debian/doc/manuals/jokinkäyttöopas.ps.gz
  http://ftp.debian.org/debian/doc/manuals/jokinkäyttöopas.sgml.tar.gz

Huomioi että tätä käytäntöä ei ole vielä yleisesti hyväksytty, joten nuo osoitteet eivät välttämättä toimi. Dokumenttien todelliset sijainnit saattavat muuttua yhteensopivuussyiden vuoksi.

Tulemme käyttämään lähdekoodin formaattina SGML:ää.
Huomaa että tämä ei tarkoita sitä että käyttäjien pitää opetella SGML voidakseen toimittaa muutoksia dokumentteihin. Hyväksymme kaikki muutkin formaatit. Ne kuitenkin käännetään SGML-muotoon jonkun Debian-Doc-henkilön toimesta.
Muita vaihtoehtoja olivat: LaTeX, HTML, Texinfo, ja useat muut vähemmistöformaatit.
Tulemme käyttämään debiandoc-sgml:ää dokumenteissamme.
Muut vaihtoehdot olivat linuxdoc-sgml tai DocBook. Linuxdoc:ia ei enää ylläpidetä; DocBook on monien mielestä liian suurikokoinen ja monimutkainen ja hankala muokattava.
Jokaisella Debian-dokumentilla tulee olemaan yksi henkilö merkittynä ylläpitäjäksi ja myös muita henkilöitä saattaa olla lueteltuna avustaviksi ylläpitäjiksi.