Quelques règles concernant la mise à jour de cette FAQ

From The Document Foundation Wiki
< Faq‎ | Rules(Redirected from FR/FAQ/Regles)
Jump to: navigation, search
  • Règle N°1 : Tout le monde est fortement invité à y participer :-)
  • Règle N°2 : Il ne faut pas créer de niveaux supplémentaires dans la hiérarchie de la FAQ pour éviter autant que possible de modifier les liens des entrées de FAQ car ceux-ci sont souvent référencés par d'autres pages et d'autres sites.
  • Règle N°3 : Une entrée de FAQ devra autant que possible être placée sous un titre de paragraphe existant.
  • Règle N°4 : Chaque entrée de FAQ sera un simple numéro sur 3 chiffres pour éviter de se creuser la tête à trouver un nom explicite et pour garder une cohérence avec l'ancienne FAQ.
  • Règle N°5 : Chaque entrée de FAQ commencera par un titre sous la forme == Le Titre de la FAQ == et comportera le plus souvent des listes d'actions en commençant la ligne par le signe *. Pour encadrer un texte (faire une citation), il faut commencer la ligne par une espace.
  • Règle n°6 : Le html sera évité tant que possible et la simplicité dans le code wiki doit être privilégiée.
  • Règle n°7 : Ne faire que des liens internes à la FAQ lorsqu'une question renvoie à une autre et non pas des renvois externes, soit pour être précis :
[[Faq/Module/xxx/fr|Titre de la faq]]

en syntaxe wiki, plutôt que :

[http://wiki.documenfoudantion.org/Faq/Module/xxx/fr| Titre de la faq] 
  • Règle N°8 : En bas de page la FAQ, précisez la catégorie, qui doit reprendre l'arborescence de la FAQ :
[[Category:FAQ/Module/fr]]
  • Règle N°9 : Pour insérer une image, il est conseillé d'utiliser un nom commençant par FR.FAQ_ et indiquant le chemin où elle est utilisée. Exemple :
FR.FAQ_Base_027_Les_Tables.png
  • Règle N°10 : Si vous relisez une FAQ et n'avez trouvé aucune erreur, vous pouvez signaler que vous l'avez relue (et donc validée) dans l'onglet "Discussion", précisant la date et le numéro de version.
  • Règle N°11 : Tout le monde peut modifier les règles ci-dessus car nous sommes sur un Wiki :-)


Les FAQ sont numérotées. Il est intéressant de conserver le principe de la numérotation pour plusieurs raisons :

  • le nom de page est le même pour toutes les langues, seule la terminaison /fr change quand on change de langue 
  • le lien est plus simple à afficher, copier/coller et mémoriser ;
  • cela permet de gérer le nom des images plus facilement ;
  • il est possible à tout moment de modifier le titre de la FAQ sans que cela change son lien ;
  • pour retrouver facilement le dernier numéro de disponible, il est possible d'utiliser ce lien :