Fr/Aide:Maintenance

Version traduite le 15 novembre 2022

Voulez-vous vous lancer dans la maintenance de la documentation parce que vous avez lu que c'est le meilleur moyen d'accéder à un projet ouvert à tous ? Pensez-vous que ce wiki peut être amélioré ? (Nous aussi.) Cet article explique au contributeur volontaire ce qui peut être fait et comment.

Remarque : cet article suppose que vous soyez déjà familier avec l'ajout de contenu à un wiki. Si vous n'êtes pas sûr, veuillez vérifier cela sur la page Votre premier article.

Qui n'est pas satisfait de ce wiki ?

Vous avez probablement ressenti ce wiki après l'avoir consulté pendant un certain temps et ne l'avez pas trouvé forcément adapté à vos besoins.Sans doute avec une certaine frustration, et quelques plans révolutionnaires. Nous y sommes tous passés.

Il y a quelque chose que vous devez savoir : l'organisation de ce wiki a déjà été beaucoup discutée, et "beaucoup" signifie ici depuis ses premières années. Elle le sera également dans le futur. Les critiques vont de suggestions légères au déchirement en lambeaux, et même des commentaires non constructifs (hum) ont été postés. Cela est probablement dû à l'apparente "pagaille" du projet FlightGear. Ce qui est réellement nécessaire, cependant, fait défaut : le temps passé à faire quelque chose, au lieu d'en discuter. C'est parce que le nombre de mainteneurs/contributeurs réguliers est beaucoup plus petit que vous ne le pensez. Pour vérifier cela, parcourez Special:RecentChanges et comptez les noms d'utilisateur les plus courants. Donc, avant de suggérer quelque chose, mieux vaut être prêt à le réaliser.

Mais rassurez-vous : malgré ce qui précède, ce wiki s'améliore de jour en jour. Demandez à un mainteneur si vous ne le croyez pas !

Ce document a été écrit à l'origine par quelqu'un comme vous, qui a pensé qu'il pourrait vous faire gagner du temps (comme le temps que vous utiliseriez pour rédiger votre plan détaillé, bien pensé et argumenté - trop tard ?).

Tracez votre chemin

Pour devenir un mainteneur à part entière, il est fondamental de se familiariser avec le fonctionnement du projet FlightGear. C'est sans doute moins évident à faire qu'il n'y parait, cela prendra de l'énergie et du temps passé à vivre avec la communauté. Certains articles que vous voudrez peut-être consulter sont :

• Volontaires (fr)
• Comment fonctionne le projet Flightgear (fr)
• Forum communication (en)
• Howto:Understand the FlightGear development process (en)
• Howto:Start core development (en)

En lisant ces documents, vous vous plongez dans l'ambiance afin de vérifier si quelque chose a changé, été corrigé ou rendu plus clair. Faire de la maintenance aléatoire tout en explorant le wiki permettra d'être plus à l'aise à la fois avec le projet et avec la façon dont le wiki est organisé. Des erreurs sont souvent commises, mais les mainteneurs garderont un œil (avec bienveillance) sur vous, alors ne soyez pas trop timide et, en cas de doute, mieux vaut demander que d'abandonner.

Le résumé

Mais s'il vous plaît, n'oubliez pas d'ajouter un commentaire significatif à votre modification. Il s'agit du champ de texte "Résumé" que vous pouvez voir sous la zone de texte de l'éditeur. Votre bon sens devrait être suffisant pour faire une description appropriée de ce que vous faites, mais si vous avez besoin d'exemples, la page Special:RecentChanges en est une source abondante.

Ce message n'est pas seulement une référence pour le futur - en fait, la plupart d'entre eux ne seront pas lus - autant qu'un message pour faire connaître aux autres responsables le reflet de votre activité.

Modifications récentes et liste de suivi

Special:RecentChanges est le principal outil de maintenance du wiki FlightGear. Il est convable à première vue et il faudra quelques heures de travail pour se familiariser, il est donc souhaitable de commencer dès à présent. Vous pouvez y voir ce qui se passe, qui a travaillé dernièrement et ce qui a été fait.

Cela représente beaucoup de données, et au début, vous voudrez peut-être vous concentrer uniquement sur quelques articles qui vous attirent. Vous pouvez le faire en les mettant dans votre liste de suivi, en cliquant sur l'étoile en haut à droite de leurs pages, à côté du champ de texte de recherche. Non seulement toute modification de ces articles apparaîtra dans cette liste, mais elle apparaîtra en gras dans les modifications récentes.

Cependant, il est peu probable que vous suiviez un article qui change souvent. Ceux-ci ont tendance à être assez désordonnés et concernent généralement des éléments de développement qui, nous le verrons plus tard, ont leurs propres règles. Ainsi, vous pouvez simplement « mettre en vedette » votre propre page de discussion, pour être sûr de ne perdre aucun message qui vous est destiné. Sans oublier Village pump !

Plus d'informations sur le suivi des modifications sont disponibles sur mw:Help:Tracking changes.

Arborescence des catégories

Un autre outil précieux, que vous connaissez peut-être déjà si vous êtes un contributeur avisé, est l'arborescence des catégories. Elle vous donne un aperçu des catégories et de leur organisation. C'est peut-être l'aspect le plus controversé du wiki, vous pourriez donc ressentir le besoin de tout changer comme si c'était votre répertoire utilisateur. Détendez-vous, vous ne pouvez pas faire ça :

1. c'est techniquement impossible ;
2. cela doit être discuté avec les mainteneurs les plus expérimentés.

Cependant, vous pouvez toujours jeter un œil. Vous verrez que le wiki FlightGear a une catégorie racine, appelée, sans grande surprise, Category:FlightGear wiki. Vous pouvez le savoir en regardant Special:UncategorizedCategories, qui répertorie les catégories qui n'ont pas de parent. Utilisez donc l'outil arborescence des catégories à ce sujet (vous pouvez ignorer l'option namespaces pour l'instant) et prenez le temps de voir comment elle est structuré.

En général, il devrait y avoir une catégorie Articles, où tout le contenu textuel est disponible, et Fichiers, où se trouvent les binaires (probablement juste des images). Les autres sont des catégories techniques, dont l'utilisation doit être explicite.

Communication avec les autres mainteneurs

En évoquant la discussion avec les autres responsables, passons quelques messages là-dessus. Communiquer via le wiki nécessite une certaine adaptation. C'est fastidieux au début, toujours ennuyeux de devoir se soucier de l'indentation et de ne pas oublier de signer vos commentaires, mais vous vous y habituerez en peu de temps.

Une chose dont vous devez être conscient, cependant, est que vous ne serez pas notifiés des réponses à vos messages. En solution de contournement, vous pouvez "marquer" la page où vous avez laissé votre message, mais vous devez vous rappeler de les "désactiver", sinon votre liste de suivi deviendra bientôt impossible à gérer (si c'est un problème). En tant que mainteneur, vous laisserez probablement tant de messages qu'il sera plus simple de vérifier les modifications récentes comme vous devriez déjà le faire.

Vou trouverez plus d'informations relatives à la communication sur les pages mw:Help:Talk.

À propos des discussions dans ce wiki

Parfois, vous voudrez connaître l'opinion des autres sur ce que vous allez faire. Il est possible que vous n'obteniez pas de réponses, ce qui pourrait signifier deux choses :

• si vous avez besoin de l'aide d'autrui, vous devrez évidemment réessayer à un autre moment ;
• si c'est un sujet que vous pouvez faire vous-même, alors vous devriez continuer dans la plupart des cas.

Dans ce dernier cas, en fait, l'absence de réponse peut être lue comme "Ok, ça ne me dérange pas si vous faites ça, au cas où, nous discuterons des résultats". Évidemment, c'est vrai si vous avez donné à tout le monde la chance de revoir votre question. Cette convention aide à maintenir l'effort de discussion au minimum.

Pour faire court : au lieu de demander la permission, annoncez ce que vous allez faire. Puis commencez à réaliser !

Tâches d'entretien courant

Avec seulement quelques heures de pratique, vous devriez être opérationnel. Voici brièvement expliqué ce que vous pouvez déjà faire bénévolement. Notez qu'il ne vous est en aucun cas demandé de faire tout ce qui suit, toute aide sera appréciée.

Vérification des nouveaux articles et des modifications

En vérifiant les modifications récentes, vous trouverez peut-être une entrée marquée d'un N, ce qui signifie qu'un nouvel article a été créé. Allez voir s'il correspond au wiki (par exemple ne parle pas du chien de l'utilisateur), si le titre pourrait être plus clair, ou si la mise en forme pourrait être améliorée... Bref, vérifiez sa qualité.

De plus, vérifiez si l'article est catégorisé de manière adéquate, surtout s'il n'est pas catégorisé du tout ! Cependant, cette tâche pourrait nécessiter un peu plus d'expertise, en particulier pour les articles liés au développement.

Si cet article a été rédigé par un nouveau contributeur, vous devriez laisser quelques indices sur sa page de discussion pour éviter la répétition d'une erreur (comme oublier le résumé). Inutile de préciser qu'il faut rester cordial: ce contributeur a probablement fait de son mieux. En fait, vous pourriez également envisager de simplement les remercier pour son ajout et l'encourager à contribujer d'avantage.

Si vous modifiez quoi que ce soit, n'oubliez pas de laisser un résumé approprié.

Vérification des points d'entrée des utilisateurs

En raison de son impact élevé sur la perception de la qualité du wiki, il s'agit probablement de la tâche de maintenance la plus importante.

Vous avez peut-être entendu parler du principe de Pareto. En bref, on dit que 80 % des résultats sont dus à 20 % des causes. Appliqué au wiki, cela pourrait ressembler à "20 % des pages du wiki affectent 80 % de la perception de la qualité du wiki" (les chiffres peuvent varier).

Ces pages sont bien sûr les plus visitées, c'est-à-dire la Catégorie:Portails et toutes les pages qui y sont liées. Visualisez-les en tant qu'utilisateur, voyez si certains sujets manquent ou s'ils sont obsolètes. Si le sujet vous paraît convenable, essayez de l'améliorer en recherchant et en demandant sur le forum s'il y a des mises à jour de dernière minute.

Une autre page qui doit rester à jour est la Foire aux questions. Essayez de supprimer, ou au moins de signaler avec un modèle, les questions que vous supposez posées plus fréquemment. De plus, en suivant le forum, vous devriez être en mesure de savoir ce que sont vraiment les FAQ, alors pensez à les ajouter si elles sont manquantes. Dans les réponses, essayez de pointer vers des articles existants au lieu de dupliquer les informations (voir chapitre suivant).

Ensuite, si vous n'avez plus de "pages les plus visitées", vérifiez simplement la page des statistiques, qui compte actuellement 3,464 articles.

En termes de FlightGear, aider à maintenir de tels articles a un grand effet multiplicateur car les utilisateurs finaux peuvent pratiquer plus facilement le logiciel et obtenir un meilleur support. De même, il existe des articles qui sont essentiellement des points d'entrée pour les contributeurs en herbe souhaitant par exemple développer des décors/avions ou aider avec le forum/wiki/newsletter, etc., ceux-ci ont également un effet multiplicateur important, car le projet trouve un nouveau souffle et un regain d'élan grâce à des contributeurs supplémentaires.

C'est aussi pourquoi certaines pages sont plus "importantes" que d'autres, car fournir un support de haute qualité est généralement difficile et nécessite certaines connaissances de base, c'est-à-dire qu'elles ne peuvent souvent être fournies que par des personnes impliquées dans la conception d'un certain système ou d'une certaine fonctionnalité - ainsi, fournir de bons guides de dépannage qui permettent aux gens de faire de bons rapports de bogues est extrêmement utile pour réduire le degré de main-d'œuvre nécessaire pour traiter certaines demandes.

Rapports d'entretien

Lorsque vous voyez un problème, il est préférable de le résoudre immédiatement, vous n'avez peut-être vraiment pas le temps/la volonté/les connaissances pour cela. Lorsqu'une telle situation se produit, vous devez ajouter un modèle de maintenance. Ce sont ces boîtes de message qui apparaissent au-dessus des articles ou des sections qui nécessitent une certaine attention. Les articles qui les contiennent son t répertoriés dans certaines sous-catégories de Category:Wiki maintenance. Ceux qui vous intéresseront le plus sont :

• Category:Cleanup - ce sont aussi de bons candidats pour les contrôles de qualité dont nous avons parlé plus tôt.
• Category:Articles to be expanded - comme ci-dessus.
• Category:Considered for deletion - ceux-ci devraient avoir une discussion en cours, vous pouvez donner votre avis.

De temps en temps, vous devriez vraiment revenir à ces listes et voir si vous pouvez faire quelque chose pour les vider. Peut-être qu'avec le temps vous pourrez même réparer une page que vous avez vous-même signalée quelque temps auparavant !

Vérification plus aléatoire

Parfois, vous devriez simplement sortir dans la rue et jeter un coup d'œil, juste pour être sûr que tout va bien. Beaucoup de choses, en fait, ont tendance à être oubliées et à devenir lentement obsolètes. Certaines pages que vous voudrez peut-être visiter se trouvent dans les pages spéciales : les pages populaires, les rapports de maintenance que vous ne consultez pas habituellement, les pages à forte utilisation.

Quelques principes directeurs

L'entretien peut parfois devenir une véritable corvée. Pour éviter cela, les mainteneurs essaient de garder leur travail simple. Voici quelques conseils.

Éviter les doublons

Écrire quelque chose à plusieurs endroits signifie qu'il doit être mis à jour à plusieurs endroits. Une bonne catégorisation aidera à trouver des articles similaires, qui devraient être fusionnés. En outre, vous devez vous efforcer de séparer les différents sujets, ce que vous pouvez faire en divisant les articles ou en déplaçant les sections vers des endroits plus appropriés. Les modèles, dans une certaine mesure, peuvent également aider.

Ecrire pour la postérité

Ce que vous écrivez maintenant devrait viser à être valide le plus longtemps possible. Essayez donc de garder les choses aussi génériques que possible et de créer des liens vers des articles existants qui seront mis à jour par eux-mêmes (ceci bien sûr aussi pour éviter les doublons.)

Gardez la perception de la qualité élevée

Un wiki non maintenu éloignera à la fois les utilisateurs et les contributeurs. Cependant, leur jugement est uniquement basé sur la perception de la qualité du wiki. Gardez celui-ci en maintenant des points d'entrée, et les gens seront plus heureux de contribuer.

Organisation des catégories

FlightGear wiki est la catégorie racine. De là, vous pouvez facilement parcourir toutes les catégories définies. Notez que les pages de catégorie existantes ont une courte description en haut, qui pourrait devoir être maintenue ainsi que d'autres pages, mais est destinée à être un guide succinct pour l'utiliser.

Bien que dans MediaWiki la hiérarchie des catégories puisse sembler avoir la forme d'une arborescence, le plus souvent, elle est structurée comme une toile. En fait, chaque article - et chaque catégorie - peut appartenir à plusieurs parents. Cela signifie qu'il existe souvent plusieurs chemins entre la racine et un article. Cette fonctionnalité peut être exploitée pour rendre un certain article plus accessible aux utilisateurs provenant de différentes régions. Un exemple est donné par les articles liés à la modélisation 3D, qui sont utiles à la fois aux développeurs de décors et d'avions. Dans le cas de Category:Aircraft, cette fonctionnalité est utilisée pour classer les avions selon différents aspects.

Garder l'arborescence saine

Cependant, cela peut générer du désordre. Il y a par exemple des cas où vous pourrez trouver des boucles, et celles-ci doivent être évitées. Ce n'est décidément pas un sujet facile, même choisir le nom d'une nouvelle catégorie n'est pas du tout anodin. Vous trouverez peut-être des directives sur la catégorisation sur la page Wikipedia:Categories, lists, and navigation templates|, et une analyse approfondie des avantages et inconvénients (et des alternatives) sur Wikipedia:Categories. Ces catégories, cependant, ne devraient être manipulées que lorsque vous avez une connaissance suffisante de l'ensemble du wiki, et après en avoir discuté avec d'autres responsables.

Limites de MediaWiki

Catégoriser si le balisage ne fonctionne pas

MediaWiki ne prend pas en charge (du moins nativement) l'utilisation de catégories telles que les balises, c'est-à-dire l'utilisation de deux ou plusieurs catégories non liées qui se combinent pour en faire une à part entière. C'est bien réel car, lorsque vous parcourez les catégories, vous ne pouvez pas les combiner. Il faut donc toujours utiliser la catégorie la plus singulière possible, ce qui n'est peut-être pas facile, étant donné la nature alambiquée de l'arbre des catégories qui présente même d'énormes boucles.

Un exemple : si un article concerne la création d'aménagements d'aéroport, il ne doit pas être "étiqueté" avec Scenery et Development (ils sont tous les deux dans Category:FlightGear), mais classé dans Scenery enhancement (qui est une autre façon de dire "scenery development ").

La modification des catégories est fastidieuse

Il n'y a pas d'autre moyen manuel d'éditer l'arborescence des catégories (par exemple, déplacer des articles, renommer des catégories...) que d'éditer une par une chaque page catégorisée, qu'il s'agisse d'un article ou d'une page de catégorie (et donc, la catégorie elle-même). Dans une certaine mesure, un tel travail peut être effectué par des bots (éditeurs de logiciels automatisés), mais ils sont assez dangereux et leur utilisation doit être très soigneusement planifiée et testée avec les responsables et les administrateurs.

Promouvoir vos idées

Vous avez lu cet article, vous avez fait quelques jours de maintenance et êtes toujours convaincu que votre idée mérite d'être discutée, et vous avez l'intention de la soutenir. Super! Écrivez à ce sujet au Village Pump! Parlez-en à un responsable ! N'ayez pas peur, cela se discutera. Vous constaterez peut-être même que cela a déjà été proposé, mais que personne ne l'a jamais mis en pratique. Si vous pensez que vous n'avez pas été compris, insistez. Si à la fin vous n'obtenez aucun soutien, eh bien, vous aurez essayé. C'est ainsi que fonctionne le projet FlightGear.

Note  Veuillez garder à l'esprit que certaines des meilleures idées récemment mises en œuvre dans FlightGear, ou une partie de son infrastructure, avaient encore une "durée de vie" de 18 à 24 mois - non pas parce que les gens ne reconnaîtraient pas les bonnes idées, mais simplement parce qu'il y a généralement un "fenêtre d'opportunité" très étroite, où les ressources telles que la main-d'œuvre, le temps libre (vacances), les compétences, l'expertise, l'expérience et le soutien de la communauté s'alignent toutes de sorte que les bonnes idées peuvent réellement être transformées en nouvelles fonctionnalités sans que nous ayons à abandonner autre chose. C'est l'un des aspects les plus importants du fonctionnement du projet FlightGear, et c'est l'un des principaux obstacles pour les nouveaux arrivants : les gens s'attendent à ce que leurs commentaires soient immédiatement pris en compte - malheureusement, nous n'avons généralement pas les ressources pour agir immédiatement, même si vous devriez avoir une excellente idée. Et les longues discussions, en particulier les plus animées, sur le forum ou la liste des développeurs n'aident pas vraiment non plus (peu importe à quel point vous avez raison !), car elles prennent également un temps précieux. Il est généralement préférable de déposer une demande de fonctionnalité qui peut être examinée par d'autres, ou même de créer un article wiki (par exemple, RFC/RFD) afin que d'autres puissent garder un œil dessus, c'est-à-dire pour créer une dynamique au fil du temps. Parfois, il se peut que vous n'obteniez aucun retour pendant des mois, voire aucun - cela arrive même aux contributeurs les plus expérimentés, y compris les développeurs principaux qui ont été développés pendant plus d'une décennie - ce n'est généralement pas un signe que les gens n'aiment pas votre idée, mais que cela prendrait trop de temps pour s'en occuper (gardez à l'esprit le Release Plan) pour le moment. Ainsi, le timing est vraiment important. Tout comme la création d'un "momentum" (idées, connaissances, tutoriels, articles, support, contributeurs qualifiés). Honnêtement, nous avons eu des milliers d'idées remarquablement excellentes discutées au fil des ans - mais la réalité est que les idées valent un sou par douzaine : les actions comptent tellement plus, c'est pourquoi une mise en œuvre médiocre bat une excellente idée. Le parfait étant l'ennemi du bien. En tant que contributeurs, nous avons tendance à utiliser les termes hack , contournement ou prototype chaque fois que nous ne sommes pas vraiment fiers de nos solutions "à court terme", qui finissent généralement par faire partie du projet depuis des années. L'action a plus de poids que les mots... Au fil du temps, vous constaterez que même les contributeurs les plus expérimentés ont déjà été dans votre situation et se sont sentis exactement comme vous, même s'ils ne sont pas encore plus frustrés. En tant que contributeurs de longue date, nous sommes probablement beaucoup plus conscients des recoins et des problèmes de FlightGear, mais nous essayons d'utiliser ces connaissances pour nous motiver et nous impliquer d'une manière ou d'une autre. Il y a pas mal de domaines qui n'étaient pas entretenus et sous-développés pendant des années - certains d'entre nous en sont devenus les mainteneurs, non pas parce qu'on nous a demandé de le faire, mais simplement parce que nous avons commencé à y contribuer. En d'autres termes : saisir l'opportunité et être le changement que vous voulez voir, même si cela signifie combler un vide - ce qui peut sembler frustrant et décourageant au début, mais au moins vous pouvez trouver vos propres termes de cette façon.