Liste des choses à faire pour le DDP

Liste de choses urgentes à faire :

Supprimer toute documentation dépassée.
Convenir d'une hiérarchie pour la documentation. Concrètement, compléter la charte, avec l'assentiment et la bénédiction de l'équipe web de Debian. Cela implique une certaine cohérence de l'emplacement des fichiers dans la zone web et dans les paquets. Un brouillon à ce sujet est disponible en ligne mais il a encore besoin d'être corrigé.
Trouver un moyen d'organiser automatiquement les traductions sur le modèle des sources WML du site web.
Déterminer les informations à inclure sur les CD et automatiser la création de l'index. Des informations appropriées sont disponibles ici et le SVN dispose de certains scripts à améliorer avant d'être intégrés dans une tâche cron.

Idées :

Voici juste une liste d'idées survenues au cours de discussions sur notre liste de diffusion. Aussi, ce sont peut-être de bonnes ou de mauvaises idées. :-)

Fournir une interface cohérente pour toutes les pages de manuel de Debian, comme beaucoup d'autres le font déjà, FreeBSD, NetBSD, OpenBSD, HP (HPUX), IBM (AIX), SGI (Irix) et Sun (Solaris). Curieusement, plusieurs serveurs (comme Fifi) fournissent déjà toutes les pages de manuel de Debian. Il existe le bogue n° 264589. Il y avait une première version bêta disponible à manpages.debian.net, mais elle n'est plus accessible.
Mettre en œuvre les URN. Cela permettrait aux utilisateurs de vérifier la documentation localement, sur les sites web ou sur les miroirs. Une configuration locale pourrait être utilisée pour indiquer les miroirs proches ou commodes, ou pour passer des commandes. doc-base pourrait utiliser des URN pour pointer vers des documents plutôt qu'utiliser des noms de fichiers.
Je suis en train de réfléchir sur les formats que nous voulons inclure dans les paquets Debian (les .deb). Nous devons inclure HTML (c'est la charte) mais certaines personnes voudraient également des versions PostScript ou TEXT. Aussi je pensais distribuer _seulement_ le source SGML et créer les formats que l'utilisateur veut au lancement (cela pourrait être au moment de l'installation ou bien après). Cela comporterait plusieurs avantages :
- les .deb seraient plus petits ;
- une plus grande flexibilité ;
- nous pourrions même ajuster les liens au moment de la compilation des documents, c'est-à-dire remplacer les liens Internet par des liens locaux si les fichiers sont présents !
- il est probablement plus facile de maintenir à jour un index global (à la dwww).
J'y vois les inconvénients suivants :
- les gens auront besoin d'installer debiandoc-sgml (mais ce n'est pas trop gros) ;
- le formatage prendra quelques secondes (pas beaucoup mais le simple fait de les dépaqueter va plus vite).
doc-base pourrait définir les fondamentaux de ce type de système, puisqu'il trace des métadonnées pour les documents.
Déterminer quels documents sont vraiment utilisés (ou demandés) par nos utilisateurs afin que nous puissions nous concentrer sur ceux-ci. C'est quelque chose qui n'a pas encore été investigué. Certaines sources d'informations pourraient être la liste de discussions des utilisateurs (mener un sondage), les statistiques web (du site www principal et des miroirs) et, comme certains documents sont également distribués comme paquets Debian, les données du concours de popularité.
Générer les informations sur les manuels disponibles présentés sur le site web par l'extraction des informations (fournies par manual.defs et version.defs) automatiquement du CVS.
Rendre possible le suivi de l'état des traductions basé sur des informations du site CVS. Considérer la réutilisation du cadre de travail développé pour le manuel d'installation de l'installateur Debian.
Suivre l'état de « dernier changement » des documents pour que les utilisateurs parcourant les documents disponibles puissent déterminer si le document est pertinent (ou non) pour eux.
Considérer de fournir de la documentation aux utilisateurs dans d'autres langues que l'anglais (le CVS contient des répertoires pour quelques langues et quelques documentations ont été écrites à l'origine dans une langue autre que l'anglais).
Considérer de fournir un mécanisme interactif pour que les utilisateurs puissent annoter les documents avec une interface de type wiki, séparée de la présentation principale sur le site web ou en utilisant la même présentation. Ce retour pourrait être utilisé par l'auteur de document et, même s'il est assez ouvert aux abus, il a fonctionné plutôt bien pour d'autres projets de documentation (PHP).
Faire utiliser un système générique de suivi des bogues par les utilisateurs pour la documentation. Il est utilisé pour les documents qui fournissent un paquet, mais tous les documents ne le font pas.