<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 &eacute;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 &agrave; 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 &eacute;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 &agrave; partir d'un m&ecirc;me document initial et a &eacute;t&eacute;
d&eacute;velopp&eacute; sp&eacute;cifiquement dans ce but. Il permet d'avoir une uniformit&eacute;
dans tous les HOWTOs.</li>
<li>    Pour l'&eacute;criture d'un mini-HOWTO, vous pouvez utiliser ce que vous voulez.
Les mini-HOWTOs doivent &ecirc;tre brefs et aborder des sujets tr&egrave;s sp&eacute;cifiques.
En g&eacute;n&eacute;ral, ils doivent &ecirc;tre rapides &agrave; &eacute;crire et &agrave; mettre &agrave; jour de fa&ccedil;on &agrave;
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&eacute;es.
</li>
<li>      Assurez-vous de la v&eacute;racit&eacute; des informations que vous allez diffuser. Cela est tr&egrave;s
important, et en cas de doute faites-en mention dans le texte.
</li>
<li>      Assurez-vous que vous utilisez bien la derni&egrave;re version du
logiciel. Indiquez o&ugrave; et comment ce logiciel est disponible
(Site FTP, r&eacute;pertoire, nom de l'archive) ainsi que le num&eacute;ro de version
et la date du logiciel.
</li>
<li>    Inclure une FAQ &agrave; la fin du document si n&eacute;cessaire. Beaucoup
de documents ont besoin d'une telle section afin d'expliquer les
probl&egrave;mes classiques et des points de d&eacute;tail qui ne peuvent pas &ecirc;tre
abord&eacute;s dans la partie g&eacute;n&eacute;rale.
</li>
<li>    Prenez mod&egrave;le sur les autres documents HOWTOs. Les sources SGML sont
disponibles sur les sites FTP.
</li>
<li>    Enfin, attendez-vous &agrave; recevoir des questions et commentaires &agrave; 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&eacute;, envoyez-le moi.
Si vous avez utilis&eacute; Linuxdoc-SGML,
il vous suffit de m'envoyer le source SGML ; je me chargerai de
formater le document. De m&ecirc;me, j'archiverai les documents sur
on <code>sunsite.unc.edu</code> et posterai r&eacute;guli&egrave;rement
ceux-ci dans les newsgroups ad hoc.</p>
<p>Il est important de passer par mon interm&eacute;diaire pour diffuser un document HOWTO.
J'ai entrepris de maintenir les documents HOWTOs, et pour ce faire,je dois savoir
qui a &eacute;crit et sur quel sujet.</p>
<p>Il vous suffit de me faire parvenir des mises &agrave; jour lorsque c'est
n&eacute;cessaire. Je me chargerai de diffuser ces derni&egrave;res.</p>
<p></p>
<p>Chapitre <a href="HOWTO-Index-6.html"> Suivant </a>, Chapitre <a href="HOWTO-Index-4.html"> Pr&eacute;c&eacute;dent </a> </p><p>Table des mati&egrave;res de <a href="HOWTO-Index.html#toc5">ce chapitre</a>,
 Table des mati&egrave;res <a href="HOWTO-Index.html#toc">g&eacute;n&eacute;rale</a></p>
<p><a href="HOWTO-Index.html"> D&eacute;but </a> du document,
 <a href="#0"> D&eacute;but de ce chapitre</a></p>