Archive:Fr FR/ProjetDocs/EcrireBrouillons

From FedoraProject

Jump to: navigation, search
Important.png
Old page
This page has been marked as "old", and likely contains content that is irrelevant or incorrect. If you can, please update this page. This page will be deleted if action is not taken.
Ecrire Brouillons
Vous trouverez ici quelques conseils sur l'écriture de brouillons à soumettre à la section ProjetDocs . La page écrire avec le Wiki explique comment contribuer à l'écriture des brouillons .
WikiGraphics Fedora Design.png
Table of Contents

Contents

Formats de fichiers préférés

Les formats de fichiers suivant sont recommandé pour les brouillons et sont facile à manipuler avec:

  • DocBookXML: utilisez le fichier example-tutorial dans le CVS du Projet Documentation.
  • Texte brut
  • OpenOffice Writer , sauvegardez au format DocBook (voir cette page pour plus d'information sur l'utilisation de Writer)

Utilisez le format et l'outil que vous trouvez le plus pratique. Consultez le Guide de la Documentation pour plus d'informations sur l'utilisation de XML, Docbook et CVS.

Structure des documents

Si vous choisissez d'écrire votre brouillon au format DocBook, utilisez le fichier example-tutorial du CVS comme point de départ. Chaque tutoriel devra commencer avec une introduction contenant les sections suivantes:

  • Introduction
  • Objectif - ce que le document permettra au lecteur d'accomplir.
  • Audience - A qui s'adresse ce document (les compétence et intérêts de vos lecteur).
  • Ressources additionnelles - les pages manet info appropriés, la documentation en rapport se situant dans /usr/share/doc, sur les système Fedora et les sites Internet.

Inclure ces sections dans votre brouillon aidera également les autres membres du Projet à vous fournir des réaction plus pertinentes.

La seconde section de votre brouillant devra inclure une brève partie expliquant les concepts techniques que vous utiliserez tout au long du document. Par exemple, le tutoriel Gérer les programmes avec Yum comporte les sections Concepts suivantes:

  • Concepts
  • About Packages
  • About Repositories
  • About Dependencies
  • Understanding Package Names

Établir les concepts technique au début du document vous permettra de vous focaliser sur les tâches que le lecteur aura à accomplir. Réutilisez les sections "about" de document déjà publié (si il existent) - ceci est tout à fait acceptable et vous épargnera un travail inutile. Le reste des sections sont le corps du tutoriel. Les documentations Fedora sont orienté tâches, donc chaque section devra être concentrée sur une tâche ou une activité particulière.

Warning (medium size).png
Indiquez s'il vous plaît votre nom, adresse e-mail, et la date. Le modèle example-tutorial contient les champs pour ces détails dans son entête.

Style d'écriture

Il y a un ensemble de règles en cours d'élaboration sur le Wiki : DocsProject/StyleGuide .

Soyez certain d'avoir lu et compris les section les fondamentaux de la documentation technique et sur la composition dans le Guide de la Documentation. Les éditeurs peuvent vous aider, mais le processus sera plus rapide si vous suivez ces instructions.

Soumission de votre brouillon

Warning (medium size).png
S'il vous plaît, n'envoyez pas directement de pièces jointes sur la liste de diffusion.

Une fois que vous voulez soumettre votre document pour relecture, envoyez un message sur la liste de diffusion avec comme sujet "Request for Review: nom_de_votre_document". Le corps de votre message devra contenir un lien vers une copie en ligne de votre brouillon.Si vous êtes également capable de fournir une version HTML, faite le, cela permet de toucher plus de monde pour la lecture et de recevoir plus de commentaires.

Si votre document fait plus de 1Mo spécifiez la taille dans votre message, pour le respect des utilisateurs de connections bas débit.