DDP's dokumentationsfremgangsmåde

Denne håndbog er meget forældet og på postlisten debian-doc er der et gjort et ufuldstændigt forsøg på at få den ajourført. Se det aktuelle udkast til de nye regler. Anvendelse af DocBook XML i stedet for debiandoc-sgml anbefales ved alle nye bidrag.

Her er en liste over beslutninger som blev taget på vores postliste og godkendt af projektmedlemmerne og vores fhv. dokumentationsbestyrer, Susan G. Kleinmann.

Alle håndbøger i Debians dokumentationsprojekt (DDP) udgives under licenser der svarer til DFSG, sandsynligvis GPL.

Vi anvender følgende mappestruktur:

Filsystem:

  /usr/share/doc/manuals/enhåndbog/index.html
  /usr/share/doc/manuals/enhåndbog.ps.gz (valgfri)

www-server:

  http://www.debian.org/doc/manuals/enhåndbog/

ftp-server:

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

Bemærk at denne del af fremgangsmåden ikke er accepteret overalt endnu, derfor virker disse URI'er måske ikke. De reelle dokumentplaceringer kan være forskellige af hensyn til bagudkompatibilitet.

Vi anvender SGML som kilde-format til vores dokumenter, helst vha. Docbook XML.
Bemærk at dette ikke betyder at brugere er nødt til at lære SGML eller XML, for at kunne indsende ændringer til vore dokumenter. Vi accepterer også alle andre formater. Men de vil blive oversat til SGML af en af gruppens medlemmer.

Bemærk desuden at nogle ældre dokumenter, som vedligeholdes af gruppen, stadig er i debiandoc-sgml-format. Disse transformeres efterhånden som der bliver tid til det, til Docbook-XML-dokumenter. debiandoc-sgml-formatet anses for at være forældet.

De øvrige muligheder var: LaTeX, HTML, Texinfo, og flere andre mindre udbredte formater.
Vi gør oversætternes arbejde lettere ved at anvende PO.
Ved at anvende po4a-værktøjerne, sikrer vi at oversættere, som ønsker at holde styr på oversættelser vha. PO-formatet, har de nødvendige værktøjer til rådighed.
Alle Debian-dokumenter vil have én person anført som vedligeholder og kan have flere personer anført som vedligeholdelsesmedhjælpere.