Aider la doc
De Freenet Doc.
Attention cet article est en cours de rédaction, par conséquent les informations que vous pouvez y trouver peuvent être erronées et/ou incomplètes.
Vous voulez nous aider à documenter Freenet ? C'est une excellente idée ! Il y a énormément de travail à faire encore...
Sommaire |
Découvrir le wiki
Créez-vous un compte sur le serveur
Le lien pour le faire se trouve en haut à droite.
Familiarisez-vous avec la syntaxe wiki
La façon la plus simple de le faire consiste à étudier une page existante. Commencez par une page simple comme Description technique. Affichez la page et cliquez sur le lien modifier en haut de la page. Vous verrez que la syntaxe est très simple.
Pour connaitre tous les détails, consultez cette page.
Entrainez-vous
Vous disposez d'une page personnelle (vous pouvez la voir en cliquant sur votre nom en haut à droite), utilisez-le pour faire vos essais. Une fois que vous serez plus à l'aise, remplissez votre page comme celles des autres rédacteurs avec les infos sur ce que vous savez faire, etc...
Les modèles de notre wiki
Nous utilisons des modèles afin de structurer notre travail et améliorer l'aspect de nos pages. Les modèles s'utilisent très simplement en insérant un tag dans le code de la page.
Le modèle info
Ce modèle est utilisé pour attirer l'attention sur un point particulièrement important d'une page de doc. Ce sont les points clés que le visiteur doit absolument connaitre.
Exemple :
{{info|Coucou !}}
Donne :
Le modèle todo
Ce modèle est utilisé pour signaler un travail à faire dans la doc. Il s'adresse aux rédacteurs de la doc et non aux visiteurs. Utilisez-le si vous trouvez une partie qui n'est pas à jour mais que vous ne savez pas corriger, ou alors pour vous rappeler d'un point que vous voulez développer plus tard.
Exemple :
{{todo|A corriger}}
Donne :
Les modèles signalant l'état d'une page
Ils sont détaillés sur la page Procedure de publication. Ils servent à signaler à quelle étape se situe une page dans le processus de publication.
Notre méthode de documentation
Discussion collective
Vous devez savoir qu'il ne faut pas partir bille en tête dans la rédaction d'une page. Il faut respecter les étapes de la Procedure de publication. En clair, il n'est pas question de modifier (à part pour corriger une faute) ou de créer une page sans en avoir discuté avant. Chaque page de la doc a une page de discussion qui lui est associée(voir le lien en haut). Commencez par y expliquer ce que vous voulez faire et nous en discuterons tous ensemble.
Il arrive aussi que l'on discute sur l'IRC, canal #freenet-doc-fr pour gagner du temps.
Définition d'objectifs
Dans le cas d'une nouvelle page, il faut commencer par définir les objectifs que la page devra remplir. Cela se fait également sur la page de discussion associée.
Cloisonnement des chapitres
Dans une page expliquant la manière d'utiliser un logiciel, il n'est pas question de partir dans une grande explication théorique sur le fonctionnement du logiciel. Ces explication ont leur place dans la Description technique. Le visiteur qui veut savoir comment envoyer un message avec Thaw se fiche complètement de savoir comment le logiciel va le faire. Chaque page doit accomplir un objectif simple, et un seul !
En cas de doute sur la structure de la doc ou sur la place où une info doit se trouver, les pages de discussion sont là pour ça.
Suivi de l'avancée des travaux
Quand une tache vous est assignée, vous devez tenir à jour son avancement sur la page Etat actuel du projet, jusqu'à 100%. Une fois que vous considérez avoir terminé, la page passe en phase de validation par les membres. Ce n'est qu'une fois validée par l'équipe de documentation que vous pourrez noter votre tâche comme terminée.
