<title>Ecrire un document HOWTO</title> <h1>5 <a name="s5"> Ecrire un document HOWTO </h1> <p> <a href="HOWTO-Index.html#toc5"> Contenu de cette section</a></p> <p>Si l'envie vous prend de participer au projet Linux en écrivant un HOWTO, il faut suivre quelques recommandations.</p> <p> <ul> <li> Avant toute chose, contactez-moi pour m'indiquer sur quoi vous voulez travailler. Vous pouvez me joindre à l'adresse <code> <a href="mailto:gregh@sunsite.unc.edu"> gregh@sunsite.unc.edu </a> </code>. </li> <li> Essayez de respecter une structure et une organisation claire. Beaucoup des gens ne lisent pas les documents HOWTOs dans leur langue maternelle. </li> <li> Pour écrire une HOWTO, il faut utiliser le package Linuxdoc-SGML disponible sur <code>sunsite.unc.edu:/pub/Linux/utils/text/</code>, pour formater votre document. Cet outil permet de produire des fichiers Latex, (pour dvi et PostScript), ASCII et HTML à partir d'un même document initial et a été développé spécifiquement dans ce but. Il permet d'avoir une uniformité dans tous les HOWTOs.</li> <li> Pour l'écriture d'un mini-HOWTO, vous pouvez utiliser ce que vous voulez. Les mini-HOWTOs doivent être brefs et aborder des sujets très spécifiques. En général, ils doivent être rapides à écrire et à mettre à jour de façon à ne pas avoir recours au package Linuxdoc-SGML. Cela ne veut pas dire que les mini-HOWTOs sont moins importants ! Seules les versions ASCII des mini-HOWTOs sont diffusées. </li> <li> Assurez-vous de la véracité des informations que vous allez diffuser. Cela est très important, et en cas de doute faites-en mention dans le texte. </li> <li> Assurez-vous que vous utilisez bien la dernière version du logiciel. Indiquez où et comment ce logiciel est disponible (Site FTP, répertoire, nom de l'archive) ainsi que le numéro de version et la date du logiciel. </li> <li> Inclure une FAQ à la fin du document si nécessaire. Beaucoup de documents ont besoin d'une telle section afin d'expliquer les problèmes classiques et des points de détail qui ne peuvent pas être abordés dans la partie générale. </li> <li> Prenez modèle sur les autres documents HOWTOs. Les sources SGML sont disponibles sur les sites FTP. </li> <li> Enfin, attendez-vous à recevoir des questions et commentaires à propos de votre travail. Il y a plusieurs centaines de de connexions tous les jours pour consulter les HOWTOs. </li> </ul> </p> <p>Une fois votre document terminé, envoyez-le moi. Si vous avez utilisé Linuxdoc-SGML, il vous suffit de m'envoyer le source SGML ; je me chargerai de formater le document. De même, j'archiverai les documents sur on <code>sunsite.unc.edu</code> et posterai régulièrement ceux-ci dans les newsgroups ad hoc.</p> <p>Il est important de passer par mon intermédiaire pour diffuser un document HOWTO. J'ai entrepris de maintenir les documents HOWTOs, et pour ce faire,je dois savoir qui a écrit et sur quel sujet.</p> <p>Il vous suffit de me faire parvenir des mises à jour lorsque c'est nécessaire. Je me chargerai de diffuser ces dernières.</p> <p></p> <p>Chapitre <a href="HOWTO-Index-6.html"> Suivant </a>, Chapitre <a href="HOWTO-Index-4.html"> Précédent </a> </p><p>Table des matières de <a href="HOWTO-Index.html#toc5">ce chapitre</a>, Table des matières <a href="HOWTO-Index.html#toc">générale</a></p> <p><a href="HOWTO-Index.html"> Début </a> du document, <a href="#0"> Début de ce chapitre</a></p>