Замечание: Оригинал этого документа новее, чем перевод.
Политика документации DDP
Это руководство довольно сильно устарело, и попытки его частичного обновления предпринимаются в списке рассылки debian-doc. См. текущий черновик новой политики. В новых документах рекомендуется использовать DocBook XML вместо debiandoc-sgml.
Вот список решений, которые были приняты в нашем списке рассылки и одобрены Менеджером документации (в отставке), Сьюзен Г. Клейнман (Susan G. Kleinmann).
- Все руководства Проекта Документирования Debian (Debian Documentation Project, DDP) будут выпущены на условиях соответствующей DFSG лицензией, скорее всего GPL.
- Мы будем использовать следующую структуру каталогов на наших
серверах:
Файловая система:
/usr/share/doc/manuals/какое-то руководство/index.html /usr/share/doc/manuals/какое-то руководство.ps.gz (необязательно)
WWW сервер:
http://www.debian.org/doc/manuals/какое-то руководство/
FTP сервер:
http://ftp.debian.org/debian/doc/manuals/какое-то руководство.html.tar.gz http://ftp.debian.org/debian/doc/manuals/какое-то руководство.text.gz http://ftp.debian.org/debian/doc/manuals/какое-то руководство.dvi.gz http://ftp.debian.org/debian/doc/manuals/какое-то руководство.ps.gz http://ftp.debian.org/debian/doc/manuals/какое-то руководство.sgml.tar.gz
Замечание: эта часть политики принята не везде, так что эти URI могут не работать. Реальное расположение может отличаться для сохранения обратной совместимости.
- В качестве исходного формата мы будем использовать SGML.
Заметим, что пользователи не обязаны знать SGML, чтобы присылать изменения в наши документы. Мы принимаем в том числе и другие форматы. Однако, эти изменения будут переведены в SGML одним из тех, кто занимается документацией Debian.
Форматы которые тоже рассматривались как возможные: LaTeX, HTML, texinfo и некоторые другие.
- Мы будем использовать debiandoc-sgml для наших документов.
Другими возможными форматами были linuxdoc-sgml и DocBook. Linuxdoc уже не поддерживается; DocBook оценивается многими как очень большой, сложный и негибкий формат.
- Каждый документ Debian будет иметь сопровождающего, и может также иметь ещё несколько людей, называемых помощниками сопровождающего.
