Ceci est une ancienne révision du document !
- une page très simple pour aider a participer : ameliorer_wiki_proposition
- et la présente page pour aider à le faire de façon plus efficace
Quelques recommandations pour optimiser les contributions. (notamment issue d'une réunion de 2006)1).
Principes de base
Quelques principes élémentaires qui sont chaudement recommandé :
- Rester aussi simple que possible : Cette notice a comme ambition de pouvoir s'adresser à tous.
- Distinguer les faits : C'est eux qui vont aider l'utilisateur. Un choix, une préférence, ou une recommandation sont du domaine des avis, il doivent être signalé comme tel en précisant selon qui.
- Ce concentrer sur ce qui est commun : C'est ce qui fait le liens entre tous les sous-sujet qui permet d'éviter de perdre l'utilisateur de cette notice et d'aborder la suite avec les idées claire.
Des métaphore pour aider :
- Le pense bête communautaire : On y met juste ce qui est utile pour soi même en laissant la possibilité aux autres de faire la même chose.
- Le bagage pour un voyage vers l'inconnu : C'est a dire tenter de mettre le maximum de chose utile tous en restant le plus léger possible, pour pouvoir faire face à des problèmes qu'on ne connais pas encore.
Pratiques technique recommandées
Selon le types d'interventions
- Modifications légères : si vous corrigez des fautes d'orthographe, des liens ou toutes autres coquilles, ou si vous améliorez la forme plutôt que le fond, alors il ne vous est rien demandé d'autre que de remplir la section « Résumé » en bas de la zone de modification : ceci permet de décrire rapidement quel genre de contribution vous avez apporté, à l'attention des autres contributeurs.
- 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.
- 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 aussi en être informé.
Selon le types d'articles
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 ».
Centraliser les infos récurrentes en utilisant les mini-tutoriels
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
Les pratiques appréciées
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 adresses utiles
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
- Pour rédiger des articles, on utilise la syntaxe DokuWiki : voir la syntaxe.
- Voir les aides à la traduction.
- La page des chantiers en cours pour ceux qui veulent aider mais sont en manque d'inspiration.