Comment participer et améliorer cette documentation ?

La documentation du site Ubuntu-fr est publiée sous forme de wiki, un système de rédaction ouvert et collaboratif que chacun est libre de modifier. Elle est la principale source d'information francophone concernant Ubuntu et les logiciels libres. Si vous êtes un bon pédagogue, aidez à l'améliorer en écrivant, en complétant, en corrigeant ou en traduisant des articles.
Tout le monde peut y participer : la modification¹⁾ d'articles ne nécessite pas d'inscription.
Que vous souhaitiez commencer un texte à partir de rien, corriger des « fautes orthographe » ou simplifier des phrases, votre contribution est la bienvenue.

Voici différentes façons de présenter à titre indicatif les bases éthiques sur lesquelles reposent les mécanismes techniques du site ubuntu-fr.org et plus précisément de cette documentation :

• Un code de conduite (issu du site anglais) est induit par les principes d'Ubuntu qui se rattachent notamment à la philosophie du même nom (voir aussi l'article « Ubuntu (idéologie) » sur Wikipédia et une vidéo représentant ce concept).
• Il ressort également de l'expérience commune quelques principes élémentaires relatifs à la documentation sous forme wiki :
  • Rester aussi simple que possible : cette notice a comme ambition de pouvoir s'adresser à tous.
  • Distinguer les faits : ce sont eux qui vont aider l'utilisateur. Un choix, une préférence ou une recommandation sont du domaine des avis. Pour obtenir un fait, il faut préciser selon qui.
  • Commencer par la base : ce qui est évident est important. C'est la première marche indispensable pour les plus novices mais aussi ce qui permet d'organiser facilement les choses plus complexes.
• Cette documentation peut aussi être représentée par des métaphores (pour imager autrement les principes précédents) :
  • c'est un pense bête communautaire : il doit permettre à chacun de retrouver ce qui est utile pour lui, sans gêner ce qui est utile pour les autres ;
  • c'est aussi un bagage pour un voyage vers l'inconnu : les choses les plus utiles doivent rester les plus accessibles, mais il faut aussi prévoir de faire face à des situations qu'on ne connaît pas encore.
• Utiliser les modèles, suivre les conseils de cette page et respecter la ligne éditoriale de la documentation !

La réunion 2006 no. 3 a déterminé la procédure de modification des pages existantes. Il a donc été décidé d'autoriser l'accès en écriture aux documentations, leur modification immédiate est autorisée, en parallèle l'abonnement des pages rendu possible avertit immédiatement de toutes les modifications des pages auxquelles certains contributeurs sont inscrits.

La documentation d'Ubuntu-fr n'est peut-être pas toujours tout à fait claire, et c'est bien normal. Elle est en constante évolution et rédigée sur une base volontaire. La meilleure façon de la voir devenir meilleure est de la critiquer (de manière constructive) et d'informer de ses observations !

Les plus téméraires voudront peut-être aussi s'abonner à la liste de diffusion des contributeurs du wiki (Coordination Wiki). Ils pourront ainsi discuter par courriel avec plusieurs contributeurs du wiki, leur présenter quels articles ils jugent difficiles et qui mériteraient une refonte. Bref, travailler en coopération avec ceux-là mêmes qui rédigent la documentation !

À défaut de modifier la page concernée, vous pouvez toujours faire part de vos critiques directement aux contributeurs. Ainsi beaucoup d'articles sont signés par leur(s) auteur(s), en bas d'article (voir la liste des utilisateurs). Vous pouvez donc cliquer dessus pour accéder à leur page utilisateur pour avoir des renseignements sur la façon de les contacter. Ainsi, n'oubliez pas d'expliquer quelle page devrait être retravaillée dans telle section car ceci ou cela est obscur et de dire en quoi cela est obscur, c'est un moyen efficace pour voir ses remarques prises en compte et de voir apporter des modifications à l'article.

Si une page vous intéresse que vous souhaitez suivre dans son évolution ou simplement surveiller contre le vandalisme, vous pouvez vous y abonner. Il vous faut au préalable être inscrit sur le forum Ubuntu puis se connecter sur la documentation avec le même identifiant. Vous pourrez alors gérer vos souscriptions.

Enfin, il est toujours possible de créer un fil de discussion dans le forum à propos d'un article précis. Quelques-uns des contributeurs au wiki passent aussi dans le forum, mais pas tous. Néanmoins, un fil de discussion aura le mérite d'attirer l'attention de personnes moins dégourdies en matière d'Ubuntu, de celles-là mêmes qui vont utiliser le wiki qui pourront réagir aux propositions, et peut-être aussi de futurs contributeurs ? Mais comme nous l'avons mentionné, tous les contributeurs ne passent pas dans le forum, donc il faudra aussi penser à les contacter pour qu'ils puissent appliquer les modifications nécessaires si personne d'autre ne s'en charge.²⁾

Il suffit de cliquer sur « Modifier cette page » (dans l'encart Actions en haut à gauche) pour avoir la possibilité de modifier une page existante.

Le bouton « Aperçu » permet de visualiser les changements et permet de les retrouver (depuis son ordinateur seulement si pas connecté, sinon depuis tous les ordinateurs). Il est nécessaire de faire un aperçu avant de pouvoir enregistrer.

Le bouton « Enregistrer » sauve la modification (sur le serveur) et la rend accessible à tous.

Pour se familiariser avec ce système, la page bac à sable permet de faire des essais sans aucun risque.

Remarque : pour effacer une page, il suffit de modifier la page, la vider de son contenu, puis de sauvegarder. Ne pas oublier de mettre en commentaire la raison pour laquelle vous avez supprimé la page.

Toutes les modifications que vous apporterez à la documentation font partie d'un des trois types ci-dessous.

Pour corriger des fautes d'orthographe, des liens ou toute autre coquille et, d'une manière générale, pour les améliorations de 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 à l'intention des autres contributeurs.

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

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ée par l'intermédiaire de la liste de discussion de la documentation. Ce type d'envoi nécessite une inscription préalable sur son portail. Cela permet aux utilisateurs de cette liste d'intervenir plus rapidement pour ajouter les logiques d'uniformisation, pour corriger les éventuelles erreurs, etc.

Pour pouvoir créer une page, il est préférable d'ê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ée par l'intermédiaire de la liste de discussion de la documentation, d'autres contributeurs plus expérimentés vous aideront à finaliser la page.

Pour créer une page dans la documentation, vous devez être connecté en tant que membre de ce site. Il s'agit du même compte que pour le forum, si vous n'en avez pas, vous pouvez en créer un ici.

Une fois connecté, allez à l'adresse que vous souhaiteriez pour votre future page, par exemple : http://doc.ubuntu-fr.org/Nom_de_la_page

Si cette page n'existe pas encore, l'option « Créer cette page » apparaît dans l'onglet Actions, sur la gauche. Cliquez dessus et c'est parti !

En cas de création d'une page, veuillez choisir l'un des modèles standardisés ci-dessous :

• Modèle de page « application » : pour présenter l'installation et l'utilisation d'un logiciel sous Ubuntu.
• Modèle de page « matériel » : pour expliquer comment faire fonctionner un matériel particulier sous Ubuntu. Il existe un modèle spécifique pour les ordinateurs portables (ci-dessous).
• Modèle de page « portable » : pour expliquer comment faire fonctionner un ordinateur portable sous Ubuntu.
• Modèle de page « tutoriel » : pour expliquer pas-à-pas comment résoudre une problématique (en utilisant généralement plusieurs applications).
• Modèle de page « portail » : pour lister les tutoriels et logiciels Ubuntu d'un thème précis.
• Modèle de page « utilisateur » : espace personnel pour se présenter

Pour pouvoir être contacté au sujet des modifications que vous apportez au wiki (généralement pour des conseils, ou en cas d'erreur dans la modification que vous apportez), il est préférable d'ê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).

Si vous comptez participer régulièrement au wiki, vous êtes invités à créer une page utilisateur. Vous pourrez vous présenter et donner un moyen de vous contacter. Si vous avez besoin de créer une page temporaire, vous pourrez la placer dans votre répertoire ainsi créé.

Faites vos essais dans le bac à sable.

Si vous avez l'intention de recopier ou traduire un article ou une partie d'article d'un autre site vérifiez certains points :

• Il est nécessaire de vérifier la licence sous laquelle cet article est placé et en conséquence si elle vous autorise à l'utiliser. À défaut contacter l'auteur par un petit courriel.
• Il vous faudra indiquer la licence elle-même, la provenance et l'auteur de l'article original.

Sinon :

• Si la licence ne le permet pas, la modification sera illégale et sera donc supprimée rapidement.

Dans tous les cas, avertissez l'auteur de l'article en question.

Lorsque vous enregistrez une modification (via le bouton Enregistrer), une entrée est créée dans l'historique de la page (la section “Anciennes révisions” de la page) et un mail est envoyé aux administrateurs du wiki ainsi qu'aux membres qui suivent la page.

Pour ces raisons évitez l'utilisation répétée du bouton Enregistrer. Tant que vous n'avez pas fini vos modifications sur une page, utilisez plutôt le bouton Aperçu (crée un brouillon récupérable sans difficulté en cas de besoin), ou bien : un fichier texte, le bac à sable ou votre espace utilisateur.

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.

Pour plus d'informations sur les tags consultez la page de documentation consacrée aux tags.

Afin d'alléger la documentation, il est demandé aux contributeurs de ne pas insérer d'images trop grandes.

Voir le tutoriel “Ajouter des images dans le wiki”.

Afin d'alléger la documentation, il est demandé aux contributeurs de ne pas expliciter directement dans la page certaines actions souvent invoquées. À la place, il est renvoyé à des « mini-tutoriels » grâce à des liens. La liste des actions en question et les liens à utiliser sont explicités dans les sections suivantes.

Voir Mini-tutoriels

Comme dans tout ce qui a trait à Ubuntu, inspirez-vous de son code de conduite.

Tout contenu ajouté au wiki ubuntu-fr doit suivre les règles et objectifs fixés dans la ligne éditoriale de la documentation.

Si vous maîtrisez bien le sujet d'une page, abonnez-vous aux modifications de cette page afin de vérifier qu'aucune erreur ne s'y glissera. Vous devez vous connecter à la documentation avec votre compte utilisateur (il s'agit du même compte que pour le forum, pour s'inscrire, c'est ici).

Pour cela, cliquez sur le bouton Gérer souscriptions dans le menu Actions à gauche. Vous arrivez alors sur la page de Gestion de l'abonnement. Choisissez ensuite si vous voulez vous abonner à cette page seulement (nom de la page), ou au dossier dans lequel se trouve cette page (*). Cliquez finalement sur Souscrire. Par la suite, vous recevrez par courrier électronique un résumé des modifications effectuées sur la(les) page(s) en question.

Pour se désabonner d'une page, procédez de la même manière que pour l'abonnement. Une fois rendu sur la page Gestion de l'abonnement, cliquez sur Annuler la souscription dans la section Souscriptions actives.

Si vous n'avez pas le temps de relire tous les guides de bonnes pratiques de rédaction à chaque fois que vous effectuez une modification du wiki, consultez au minimum la Checklist du contributeur. Cette liste synthétique reprend en 10 points l'essentiel des choses à vérifier pour être sûr d'être en harmonie avec le reste de la doc.

Vous pouvez commencer par corriger les fautes d'orthographe, puis améliorer les pages des sujets que vous connaissez bien.

Ensuite, votre aide sera appréciée notamment pour les chantiers en cours du wiki, et les appels à contributions qui apparaissent régulièrement sur la mailing-list du wiki !

En cas de doute ou de problème : contactez les administrateurs du wiki.

Une liste de discussion (appelée également mailing-list en anglais) est disponible pour les contributeurs du wiki. Elle permet de recevoir et de participer aux discussions en rapport avec le wiki. Nous vous recommandons de vous y inscrire, notamment pour y annoncer vos modifications importantes. C'est le meilleur moyen pour avoir des retours sur vos modifications.

Vous trouverez à cet endroit les adresses d'inscription à la liste de discussion du wiki. Ainsi que des informations plus globales sur l'ensemble de la page.

Vous pouvez également discuter avec les contributeurs du wiki sur le chan : #ubuntu-fr-doc Si vous ne disposez pas de client IRC vous pouvez vous rendre sur cette page. Il vous suffit ensuite d'entrer un pseudo dans le champ Nickname puis #ubuntu-fr-doc dans le champ Channels pour accéder au salon de discussion.

• Pour rédiger des articles, on utilise la syntaxe DokuWiki : voir la syntaxe (page dokuwiki expliquant la syntaxe).