Contenu de cette section
Si l'envie vous prend de participer au projet Linux en écrivant un
HOWTO, il faut suivre quelques recommandations.
- Avant toute chose, contactez-moi pour m'indiquer sur quoi vous
voulez travailler. Vous pouvez me joindre à l'adresse
gregh@sunsite.unc.edu
.
- Essayez de respecter une structure et une organisation claire.
Beaucoup des gens ne lisent pas les documents HOWTOs dans leur
langue maternelle.
- Pour écrire une HOWTO, il faut utiliser le package Linuxdoc-SGML
disponible sur
sunsite.unc.edu:/pub/Linux/utils/text/, 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.
- 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.
- 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.
- 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.
- 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.
- Prenez modèle sur les autres documents HOWTOs. Les sources SGML sont
disponibles sur les sites FTP.
- 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.
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 sunsite.unc.edu et posterai régulièrement
ceux-ci dans les newsgroups ad hoc.
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.
Il vous suffit de me faire parvenir des mises à jour lorsque c'est
nécessaire. Je me chargerai de diffuser ces dernières.
Chapitre Suivant , Chapitre Précédent
Table des matières de ce chapitre,
Table des matières générale
Début du document,
Début de ce chapitre