Guide du contributeur Wiki

Pour bien contribuer au wiki, veuillez respecter les conventions suivantes :

  • Ecrivez en bon français !
  • Respectez les conventions décrites sur cette page
  • Utilisez une mise en page cohérente et régulière (h1 pour le titre de la page, h2 et h3 pour les sous-titres, etc.)
  • Attention aux conventions de nommage :
    • GepiDoc_ comme préfixe pour les pages étant appelée directement depuis Gepi
    • DocRef_ comme préfixe pour les pages de la documentation de référence (module par module)
  • Les pages doivent être situées au bon endroit
    • Partie 'installation et mise à jour' : tout ce qui concerne les opérations d'installation et mise à jour, organisées dans des sous-parties progressives (cas général en premier, puis cas particuliers ensuite). Les tutoriaux complets (ex: installation pas à pas sur un serveur dédié sous Debian Lenny) doivent être situés dans une sous-partie spécifique
    • Partie 'guides et conseils pour les administrateurs' : il s'agit vraiment de guides et conseils sur des opérations particulières et potentiellement transversales, comme par exemple l'initialisation en début d'année (avec les problématiques d'archivage), la mise en place d'une politique de sauvegarde, etc. Attention à ne pas trop déborder sur le contenu de la documentation de référence (ne pas hésiter à faire des liens vers la documentation de référence en cas de besoin).
    • Partie 'guides et conseils pour les utilisateurs' : comme pour la partie décrite ci-dessus, mais à destination des utilisateurs. Ce peut-être par exemple une partie 'Du bon usage des carnets de note' destinée aux professeurs. Cette partie contient une sous-partie spécifique qui intègre toutes les pages GepiDoc_* appelée directement depuis Gepi.
    • Partie 'documentation de référence' : documentation exhaustive module par module. Attention à ne pas déborder, il s'agit bien de documenter précisément un module (= un ensemble de fonctionnalités regroupées dans un ensemble logique)

Attention à ne pas abuser des fichiers attachés aux pages. Pour permettre un meilleur suivi et faciliter les contributions des autres rédacteurs, essayez de toujours faire des pages complètes en bonne et due forme. Les fichiers attachés ne devraient être utilisés que pour des éléments complémentaires qui ne peuvent pas prendre de forme textuelle (par exemple des copies d'écran).