Proposer un logiciel

De Framawiki.

Framatutos

Proposer un logiciel
pour l'annuaire Framasoft

Logiciel et version : Framasoft
Plateforme : Web
Domaine : Site Web
Site du logiciel : http://www.framasoft.net

Auteur : Pyg
Licence du tutoriel : CC-by-sa
Difficulté : tout public
Actualisation : à jour


Modifier

Sommaire

Introduction

Ce document se veut plus détaillé que le manuel de référence « Framasoft à besoin de vous ». N'hésitez à vous y reporter pour trouver des captures illustrant le propos.

Ce manuel est la version web et à jour du document [PDF suivant].

Il décrit la création d'une notice logicielle pour l'annuaire de Framasoft.

Principes généraux

Les grandes étapes

Proposer un logiciel n'est pas compliqué, pour cela il vous suffit de suivre quelques étapes très simples :

  1. Vérification de la licence: l'annuaire de Framasoft ne référence que des logiciels libres. Vous pouvez avoir une définition de ce qu'est un logiciel libre en lisant « Qu'est ce qu'un logiciel libre ». Si le logiciel que vous souhaitez présenter n'est pas libre, nous ne pourrons pas le référencer, sa soumission est donc inutile.
  2. Vérification de sa présence dans l'annuaire : Framasoft référence déjà plus d'un millier de logiciels, il se peut donc que le logiciel que vous souhaitez proposer soit déjà référencé sur l'annuaire de logiciels libres. S'il existe déjà, vous pouvez peut­ être alors faire une mise-à-jour de sa notice (voir le paragraphe sur la mise à jour et l'article Framasoft à besoin de vous). S'il n'existe pas, alors on continue.
  3. Vérification de la pertinence de l'ajout du logiciel. Framasoft s'adresse au grand public, nous ne devons pas le noyer sous les informations, c'est pourquoi nous sélectionnons les logiciels à ajouter dans l'annuaire.
  4. Création de la notice (voir le paragraphe « Création d'une notice »).
  5. Rédaction de la notice (détaillée dans le paragraphe « Rédaction d'une notice »).
  6. Soumission de la notice en vue de sa publication. Cela aura pour effet de signaler votre notice aux modérateurs qui pourront alors l'évaluer. Tout est détaillé dans le paragraphe « Soumission de la notice ».

Schémas généraux

Nouveau logiciel Mise à jour majeure Mise à jour mineure
Vérification: licence libre, pertinence de l'ajout à Framasoft, absence de l'annuaire Notice à retoucher en profondeur : nouvelle version, notice embryonnaire... Légère imperfection dans la notice : faute d'orthographe, lien mort, lien manquant...
Ajout de la notice du logiciel sur le wiki. Exportation de la notice sur le wiki depuis la boîte de mise à jour sous la notice. Description détaillée du point soulevé via le formulaire prévu pour dans la boîte de mise à jour sous la notice.
Rédaction de la nouvelle notice (en respectant les quelques règles). Rédaction de la nouvelle notice (en respectant les quelques règles). Validation du formulaire.
Soumission de la notice (le statut passe de: Ouverture à Attente). Soumission de la notice (le statut passe de: Ouverture à Attente). Les modérateurs recevront les remarques et agiront en conséquence .
Évaluation de la notice par un administrateur. Évaluation de la notice par un administrateur.
Résultat de l'évaluation : publication de la notice, demande de compléments ou rejet. Résultat de l'évaluation : publication de la notice, demande de compléments ou rejet.

Les critères de sélection

Framasoft est un annuaire qui ne se veut pas exhaustif, mais qualitatif. Pour cela nous effectuons une sélection des notices. Cette sélection s'effectue intervient sur deux aspects :

  1. la qualité de la notice : elle doit être rédigée, pointer les qualités comme les défauts avec objectivité, avoir un avis personnel, ne pas être le copier/coller du site officiel, etc.
  2. des critères subjectifs : c'est plus difficile à expliquer, mais le modérateur peut estimer que le logiciel ne correspond pas à la cible grand-public de Framasoft. C'est difficile à comprendre, mais c'est aussi ce qui fait la force de la sélection proposée.

Comment proposer un logiciel ?

Création d'une notice

Vous avez tout vérifié et vous souhaitez nous proposer une notice : merci ! :-) La première chose à faire est de vous rendre sur la page d'accueil de notre wiki afin de créer la notice. Pour ce faire, il suffit d'entrer le nom du logiciel concerné dans la case prévue à cet effet sur la page d'accueil du wiki, puis de cliquer sur le bouton « Nom du logiciel ».

Nouveau.png

Une page au nom du logiciel proposé est alors crée, elle contient un gabarit de notice qu'il vous suffit de remplir.

Un exemple de notice est également également affiché dans le bas de la page d'édition de la notice.

Edit.png

Rédaction d'une notice

Lors de la création d'une notice, certains éléments sont indispensables. Les voici :

Les mots clés

Il va tout d'abord falloir ajouter des mots clés à votre notice. Les mots clés obligatoires sont:

  • la licence;
  • l'url du site officiel;
  • la taille;
  • les systèmes d'exploitation acceptant le logiciel;
  • la version du logiciel testé.

D'autres mots clés peuvent venir s'ajouter à ces derniers:

  • l'auteur (si vous avez participé à la rédaction de la notice, vous pouvez vous ajouter parmi les auteurs de la notice);
  • l'url d'une capture d'écran, ou de la galerie de capture du site officiel;
  • le langage utilisé pour la création du logiciel, le type de base de données, ... ;
  • l'url de la page indiquant comment faire un don ou venir en aide aux auteurs du logiciel.

La description

La description est essentielle, elle doit guider l'utilisateur. En une courte phrase, vous devez décrire l'utilité principale du logiciel afin de permettre aux visiteurs de choisir d'aller voir ou non l'intégralité de la notice pour en savoir plus. La description est, en général, la première chose que le visiteur voit lorsqu'il cherche un logiciel sur l'annuaire de Framasoft.

Le corps de la notice

Une notice comporte en général 4 grandes parties, mais vous pouvez innover :)

Une rapide description

Elle permet de placer le visiteur dans le contexte en lui indiquant directement dans quel domaine le logiciel sera utile (graphisme, bureautique, ...). Cela est important car tous les visiteurs n'arrivent pas forcément via l'annuaire de Framasoft, mais peuvent arriver sur la notice via un lien d'un autre site ou via un moteur de recherche.

Pour cette partie, il faudrait, dans la mesure du possible, utiliser les mots les plus simples afin qu'ils soient compréhensibles par le grand public : non-informaticiens, écoliers, francophonie...

Le détail des fonctionnalités

Ce paragraphe permet aux visiteurs de savoir plus précisément à quoi peut servir le logiciel et s'il peut lui être utile. Il faut donc, dans ce paragraphe, décrire le logiciel en partant du général (interface, ergonomie...) pour arriver au particulier (options spécifiques, vocabulaire technique). Ne pas hésiter à insister sur quelques "points forts" (multi-plateformes, multilingue, peu gourmand en ressources, site officiel clair et bien conçu, traduit en français, communauté active, etc.) sans omettre les manques ou les erreurs/bugs présents dans le logiciels.

Inscrire si possible le logiciel dans le contexte

L’idéal est d’avoir une certaine connaissance des autres logiciels de la catégorie (qu’ils soient libres, gratuits ou commerciaux) afin de vous livrer à quelques comparaisons simples. Il est ainsi particulièrement difficile de parler d’OpenOffice.org sans évoquer la suite Microsoft Office (ne serait-ce que pour inciter à la migration ! ). Ensuite puisque nous contribuons à l'élaboration d'un site web, garnissez au maximum les notices de liens vers les logiciels cités. La plupart des logiciels, s'ils sont libres, seront déjà présents dans l'annuaire, sinon il suffit de les y ajouter ;).

Commentaire et avis personnel

Ne pas taire les éventuels bugs ou imperfections rencontrés, mais terminer si possible par une note positive car l’atmosphère générale du site est tout de même d’inciter à essayer voire adopter des logiciels libres. "Au final, malgré ceci et cela, c’est un logiciel (très) intéressant car ça et ça". Attention, le fait de ne mettre aucun manque ou bug dans la notice d'un logiciel (dans cette partie ou dans le détail des fonctionnalités) donne une notice peu objective, ce qui ralentit sa validation, obligeant le plus souvent à amender la notice. Il s’agit d’être le plus objectif possible tout en donnant envie mais sans forcer le trait (c’est tout un art ! ).

Les liens du post­scriptum

Certains liens peuvent aider les utilisateurs, par exemple des liens vers des tutoriels, des fichiers d'exemple, des outils ou des plugins qui peuvent être associés au logiciel présenté. On pointe donc ici vers les ressources connexes qui n'avaient pas leur place sous forme de liens dans le corps de la notice.

Quelques remarques sur votre notice

  • Se méfier des superlatifs, d’autant que la vérité d’aujourd’hui n’est peut­-être pas celle de demain, surtout en informatique. Préférez la prudence d’une phrase telle que « l’un des meilleurs de sa catégorie » à « le meilleur de sa catégorie ».
  • Nous ne sommes pas bien placés pour en parler, mais Framasoft c’est aussi un ton, voire un style. Travaillant bénévolement et en totale indépendance, il n’y a pas de raison de ne pas en profiter ! Libre à vous donc de vous exprimer en donnant libre cours à votre personnalité, cela rend l’exercice beaucoup plus amusant. L’idée, c’est de faire quelque chose de sérieux tout en conservant une certaine décontraction.
  • Framasoft accueille plus de cinquante mille visiteurs par jour. L’une des ambitions du site est de faire découvrir les logiciels libres à un public non initié dont la culture informatique n’est pas forcément la vôtre. Il ne faut donc pas craindre le « raz des pâquerettes » ou plutôt, encourager une certaine vulgarisation. En fait la gageure est d’être accessible au plus grand nombre tout en restant pertinent pour les visiteurs « experts ».

Aide à la mise en page

Un pense-bête pour la mise en page des article sous SPIP à été rédigé ici : http://www.framasoft.net/article2118.html

Comme il est précisé dans le gabarit de notice que vous allez éditer dans le wiki, il est préférable d'incorporer la syntaxe de SPIP dès le début afin de faciliter le passage d'un outil à l'autre. Des boutons produisant la syntaxe de mise en page de SPIP sont d'ailleurs placés dans la page d'édition du wiki.

Soumission de la notice

La soumission

Afin d'avertir les modérateurs que vous pensez avoir fini votre notice et qu'elle peut être publiée sur l'annuaire de Framasoft, il vous suffit de changer le statut de la notice. Pour ce faire, modifiez le statut Ouverture en statut Attente. Il suffit pour cela changer le mot entre les deux paires de crochets tout en haut de la page de wiki de votre notice. Des modérateurs passent régulièrement sur le wiki afin d'évaluer les notices. Votre notice sera alors lue et évaluée.

Le résultat de la soumission

L'évaluation de la notice peut déboucher sur trois résultats différents :

  • Publiable : formidable, vous nous avez bien aidé, votre notice est déclarée apte à entrer sur l'annuaire de Framasoft, vous serez bientôt connu dans le monde entier avec la gloire que cela apporte :­). Ou plus simplement, votre notice sera ajoutée dans les prochains jours à l'annuaire, et nous vous remercions chaleureusement pour cette participation qui, nous l'espérons, vous aura donné envie de continuer avec nous.
  • Incomplète : votre notice ne remplit pas encore tous les critères pour être publiée sur l'annuaire de Framasoft. Les manques vous seront annoncés dans la partie discussion de votre notice afin que vous puissiez la retravailler et nous la proposer de nouveau lorsque vous l'aurez améliorée. Les cas les plus fréquents de mise en « Incomplète » sont : une notice pas assez rédigée, pas assez objective, sans avis personnel, etc.
  • Refusée  : votre notice ne sera pas publiée sur Framasoft. Il peut s'agir d'un logiciel non libre, ou ne correspondant pas à l'objectif de Framasoft (voir le paragraphe sur les critères de sélection). Quoi qu'il en soit, la raison de refus vous sera expliquée dans la page de discussion de la notice.

Comment mettre à jour une notice ?

Les grandes étapes

Vous venez de lire une notice qui n'est plus à jour, qui vous semble faible, qui vous déçoit par sa qualité ou à laquelle vous souhaiteriez ajouter des éléments : pas de problème et bienvenue pour cette participation.

Pour cela, il suffit de suivre cette procédure:

  1. Dépliez la boîte des mise à jour sous la notice.
  2. Choisissez s'il s'agit d'une mise à jour mineure ou majeure.
    • S'il s'agit d'une mise à jour concernant des fautes d'orthographe, des liens morts, l'ajout d'un ou plusieurs liens dans le post scriptum, alors vous pouvez suivre la procédure de mise à jour mineure.
    • S'il s'agit d'une mise à jour plus en profondeur, suite à une nouvelle version du logiciel ou pour une réécriture complète, alors veuillez suivre la procédure de mise à jour majeure.

Attention, les mises à jour que nous appelons mineures nous sont toutefois précieuses, car elles qui garantissent la qualité de l'annuaire.

Mise à jour mineure (mais essentielle ;­) )

En choisissant cette option, vous vous retrouvez devant un formulaire de courriel. Dans ce formulaire, nous vous demandons de donner un maximum d'information sur la correction que vous souhaitez apporter.

Par exemple, si vous avez repéré une faute d'orthographe, essayez de nous donner sa localisation la plus précise (paragraphe et ligne du paragraphe par exemple) ainsi que sa correction (oui, tout le monde n'est pas forcément bon en orthographe :p). De même pour un lien mort, il serait préférable, si vous avez pu retrouver le bon lien, de le préciser dans votre message.

Une fois l'information écrite, il vous suffit de nous l'envoyer et nous essaierons de comprendre de quoi il s'agissait pour retoucher la notice en conséquence.

Mineure.png

Mise à jour majeure

Vous souhaitez éditer en profondeur la notice du logiciel, pour cela nous allons vous renvoyer vers un wiki (http://wiki.framasoft.info). Deux cas peuvent se présenter :

  • Soit vous êtes le premier à vouloir modifier cette notice : nous créons automatiquement une copie de la notice sur le wiki afin que vous puissiez la modifier comme bon vous semble
Majeure.png
  • Soit vous n'êtes pas le premier à vouloir modifier cette notice et cette dernière se trouve donc déjà en cours d'édition. Dans ce cas là, vous serez orienté vers la page existante dans le wiki après avoir été averti.
Existante.png

Pour tout ce qui concerne la rédaction de la notice, toutes les instructions se trouvent dans la partie « Rédaction d'une notice » et « Soumission de la notice »


Framasoft : http://www.framasoft.net

La route est longue, mais la voie est libre.