Ceci est une ancienne révision du document !


Cette page est majoritairement issue de la page ameliorer_wiki. Elle fait partie d'une proposition de réécriture incluant la page ameliorer_wiki_proposition.

Il existe une page pour pouvoir en discuter


Des recommandations sont faites pour favoriser le travail commun. Choisir de les suivre permet d'optimiser l'efficacité de ses propres contributions tout en facilitant le travail des autres. (Elle sont notamment le résultat d'une réunion ayant eut lieu en 2006)1).

Les recommandations sont présenté de différentes manières :

  • Selon le types d'interventions ( en fonction de l'importance des modifications effectuées)
  • et selon de type d'article (en fonction de la nature du sujet)

Une démarche vise également a Centraliser les informations récurrentes en utilisant les mini tutoriels

Enfin quelles pratiques appréciées sont répertoriées.

  • Modifications légères : Pour corriger des fautes d'orthographe, des liens ou toutes autres coquilles, et d'une manière générale pour les amélioration la forme plutôt que du fond, le fait de remplir la section « Résumé » en bas de la zone de modification permet de décrire rapidement le genre de contribution a l'intention des autre contributeurs.

Cette pratique est apprécié car elle facilite grandement l'utilisation de l'historique.

  • Interventions importantes : en cas de refonte d'articles, d'ajout ou de suppression de passages ou plus généralement de modifications changeant grandement le sens du document, L'équipe qui gère cette documentation souhaite en être informé par l'intermédiaire de la la liste de discussion de la documentationdocumentation. Ce type d'envoi nécessite une inscription préalable sur son portail.

Cela permet aux utilisateurs de la mailing liste d'intervenir plus rapidement pour ajouter les logiques d'uniformisations, pour corriger les éventuelles erreurs, …

  • Créations de nouvelles pages : Pour pouvoir créer une page, il faut être connecté en tant que membre de ce site (il s'agit du même compte que pour le forum, pour s'inscrire, c'est ici). Comme c'est aussi une intervention importante, l'équipe qui gère le wiki souhaite également en être informé par l'intermédiaire de la mailing liste

Modèles de page

En cas de création d'un page il existe des modèles standardisé :

  • materiel pour la création d'une page concernant sur du matériel informatique (hardware)
  • application, pour la création d'une page concernant un logiciel (software).

Il existe essentiellement 3 types d'articles sur le wiki :

  • Les pages application : leur but est d'expliquer et présenter une application (installée par défaut ou non). Il existe un modèle pour ce type d'articles. Les pages application sont placées à la racine du wiki.
  • Les pages matériel : leur but est d'expliquer comment faire fonctionner un matériel particulier sous Ubuntu. Il existe un modèle pour ce type d'articles ainsi qu'un modèle spécifique pour les portables. Veillez à être le plus généraliste possible (par exemple, un modem PPPOE s'installe de la même manière pour tous les fournisseurs d'accès : il n'est pas nécessaire d'écrire une nouvelle page pour Free, Skynet, Alice, etc.). Les pages matériel doivent comporter le tag « matériel » et sont placées à la racine du wiki.
  • Les tutoriels : Ils se proposent de résoudre une problématique et utilisent généralement plusieurs applications (exemple : Personnaliser son kernel ou comment compiler un kernel sur mesure ?). Les tutoriels n'ont pas vraiment de modèle ; veillez cependant à mentionner les versions d'Ubuntu pour lesquelles il est écrit. Les tutoriels doivent comporter le tag « tutoriel » et sont placés dans le sous-dossier « tutoriel ».

Afin d'alléger la documentation, il est demandé aux contributeurs de ne pas expliciter directement dans la page certaines actions souvent invoquées. A la place, il est renvoyé à des "mini-tutoriels" grâce à des liens. Voici la liste des actions en question et les liens à utiliser :

Installation de paquets

Utilisez une phrase du type : Installez les paquets foo bar etc grâce au code :

[[:tutoriel:comment_installer_un_paquet|Installez les paquets]] **foo bar etc**.

Suppression de paquets

Utiliser une phrase du type : Supprimez les paquets foo bar etc grâce au code :

[[:tutoriel:comment_supprimer_un_paquet|Supprimez les paquets]] **foo bar etc**.

Édition de fichier

Utilisez une phrase du type : Éditez le fichier /chemin/du/fichier grâce au code :

[[:tutoriel:comment_editer_un_fichier|Éditez le fichier]] **/chemin/du/fichier**.

Modification des sources de mises à jour (dépôts)

Utilisez aussi un lien vers le tutoriel du type :
Modifiez vos sources de mises à jour pour y ajouter le dépôt suivant :

deb http://url_du depot …

Code à utiliser :

[[:tutoriel:comment_modifier_sources_maj|Modifiez vos sources de mises à jour]] pour y ajouter le dépôt suivant :
<file>deb http://url_du depot …</file>

Recharger la liste des paquets

Utilisez une phrase du type : rechargez la liste des paquets grâce au code :

[[:tutoriel:comment_modifier_sources_maj#recharger_la_liste_des_paquets|rechargez la liste des paquets le fichier]]

Création d'un Lanceur

Utilisez un lien vers le tutoriel du type : Créez un raccourci en utilisant comme commande :

foo

Code à utiliser :

[[:raccourci-lanceur|Créez un raccourci]] en utilisant comme commande :

  foo

Créer une page utilisateur

Créer une page utilisateur permet de mettres quelques informations pour se présenter ou encore pour donner un moyen d'être contacté, ou encore de créer des pages temporaires dans cette page utilisateur pour plus de commodité.

Les sources

Ce qui recopié ou traduit il est nécessaire de vérifier la licence sous laquelle cet article est placé (

  • Si la licence ne le permet pas la modification serra illégale, et serra donc supprimé rapidement).
  • Si elle le permet il faut l'indiquer pour éviter qu'elle soit supprimé en précisant la provenance et l'auteur de l'article original (D'ailleurs, un petit courriel à cet auteur lui fera sûrement plaisir).

Utiliser le bouton Aperçu

Lorsque vous éditez une page, l'utilisation du bouton Aperçu permet de sauver régulièrement les modifications apportés et évite de les perdres en cas de plantage sans avoir recours au bouton Sauver. Il crée un brouillon que récupérable sans difficulté en cas de besoin.

De trop nombreuses sauvegardes surchargent la page Derniers changements et la boîte aux lettres de ceux qui reçoivent un courriel à chaque sauvegarde (si si, y'en a ;-).

Utiliser les tags modérément

Chaque page doit être référencée avec au moins un tag (mot-clé). Mais n'en abusez pas : trop de tags est contre-productif. Inspirez-vous des tags présents dans les modèles de pages application et matériel et essayez de vous limiter à ceux déjà existant (voir la liste des tags). Et n'oubliez pas que la règle, c'est de mettre les accents dans les tags (matériel et non materiel par exemple).

Respecter le code de conduite

Comme dans tout ce qui a trait à Ubuntu, sa philosophie induit un code de conduite.

Les coordinateurs

En cas de doute, en cas de problème : contactez un coordinateur ! Ils sont accessibles par courriel : _Enchained, Ner0lph et DidRocks.

La liste de discussion

Une liste de discussion est disponible pour les contributeurs du wiki. Il est recommandé de s'y inscrire et d'y annoncer ses modifications importantes.

Plus d'informations sur cette page

Autres adresses

—-b


  • wiki/recommandation_wiki_proposition.1230860733.txt.gz
  • Dernière modification: Le 18/04/2011, 14:45
  • (modification externe)