Rédiger de la documentation

Il est de notoriété publique que la majorité des informaticiens n’aime pas rédiger de la documentation. C’est donc un domaine en manque de contributeurs!

Le projet de documentation Debian (DDP pour les intimes) est le point central qui essaie de fédérer toutes les initiatives de création de documentation autour de Debian. Mais il suffit de jeter un oeil sur la liste de diffusion associée (debian-doc@lists.debian.org) pour se rendre compte que l’activité du projet est minime.

Pourtant, de nombreux documents sont sous sa responsabilité. Certains concernent les utilisateurs, d’autres plutôt les développeurs, et les derniers sont regroupés dans une catégorie « divers« . Chaque écrivain (technique) en herbe peut y trouver son bonheur!

Pour le moment, la majorité des documents sont rédigés en DebianDoc SGML (paquet debiandoc-sgml) et sont gérés dans un dépôt cvs. Les documents qui sont empaquetés ont souvent une liste de bogues associés (ex: apt-howto, developers-reference, debian-history…). Cette dernière contient souvent des idées d’amélioration qui peuvent constituer un point de départ pour contribuer. Armé de votre éditeur de texte préféré, de cvs pour télécharger la dernière version des sources, et de diff pour créer des patchs, vous pouvez vous lancer dans l’aventure.

Il ne faut pas hésiter à se présenter sur la liste de diffusion, à mentionner sa volonté de participer (en précisant les sujets qui vous intéressent plus particulièrement), et – bien entendu – à poser des questions lorsque vous vous êtes bloqués.

Cet article fait partie d’une série expliquant – par des exemples – comment contribuer à Debian.