DDP - dokumentoinnin menettelytavat
Tämä opas on melkoisen vanhentunut ja on olemassa epätäydellinen ponnistelu asian korjaamiseksi debian-doc-postilistalla. Tuorein vedos dokumentista löytyy täältä. Kaikkiin uusiin kontribuutioihin suositellaan käyttämään DocBook XML:ää aiemman debiandoc-sgml:n sijasta.
Tämä on luettelo päätöksistä, jotka tehtiin postilistallamme ja jotka on hyväksyneet projektin jäsenet sekä aiempi dokumentoinnin johtaja (eläköitynyt), 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:ää
dokumenteillemme, mieluiten käyttämällä Docbook-XML:ää.
Huomaa että tämä ei tarkoita sitä että käyttäjien pitää opetella SGML tai XML voidakseen toimittaa muutoksia dokumentteihin. Hyväksymme kaikki muutkin formaatit. Joku ryhmän jäsenistä kuitenkin kääntää ne SGML-muotoon.
Huomaa, että jotkut vanhemmat ryhmän ylläpitämät dokumentit ovat edelleen debiandoc-sgml-muodossa. Nämä muunnetaan aikataulun salliessa DocBook XML -dokumenteiksi. Debiandoc-sgml-muoto katsotaan vanhentuneeksi.
Muita vaihtoehtoja olivat: LaTeX, HTML, Texinfo, ja useat muut vähemmistöformaatit.
- Helpotamme kääntäjien työtä käyttämällä PO-muotoa.
Käyttämällä po4a-työkaluja varmistamme, että kääntäjät, jotka halutessaan seurata käännöksiä PO-muotoa käyttämällä, voivat tehdä sen kunnon työkaluilla.
- 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.