Comment écrire un article pour le wiki ?

A l’origine, les articles du wiki sont des échanges de connaissances utiles (E.C.U.). Gardez bien en tête cette notion. C’est tout l’esprit de notre démarche.

Prérequis :

Pour pouvoir rédiger un article sur le wiki, vous devez être inscrit sur le site des Brickodeurs. En effet, cela vous permet d’accéder à l’interface d’écriture. Si vous ne l’avez pas déjà fait, vous devez valider La charte des Brickodeurs et Notre manifeste. Cela vous permettra ensuite de pouvoir acquérir des badges de compétences (https://brickodeurs.fr/ton-passeport-de-competences/). Après ces prérequis nous pouvons commencer !

Situation :

La méthode SPRI développée par Louis Timbal Duclos est un plan type d’exposé particulièrement bien adaptée à l’exposé d’un problème. Elle se décompose en quatre parties :

• situation qui met en évidence le contexte du problème rencontré ;
• problème qui pose la difficulté rencontrée ;
• résolution qui établit la façon dont vous avez trouvé la solution ;
• information complémentaire qui fournit des données plus détaillées sur les conditions de mise en oeuvre.

Cela vous permet d’avoir un plan de base pour structurer votre article et vous inspirer, même si au départ, vous n’avez pas beaucoup d’idées.

Selon le degré de complexité du problème que vous avez rencontré, elle comportera une seule phrase ou plusieurs. Mais dans tous les cas, elle explicitera la situation et pourquoi celle-ci est insatisfaisante.

Vous expliquez ce que vous vouliez faire au départ. En appliquant votre idée de départ, cela n’a pas fonctionné comme vous le souhaitiez. Pourquoi ? Voilà, ce que vous devez expliquer.

Problème :

Cette partie présente le résultat que vous attendiez et qui ne s’est pas produit.

Exemples :

• le robot ne détecte pas la ligne noire alors que le capteur de couleur semble allumé.
• Le personnage de mon jeu passe à travers l’obstacle sans le détecter.

Résolution :

Dans cette partie, vous expliquez comment vous avez résolu votre problème. En fonction du temps que vous vous accordez pour rédiger votre article, vous pouvez expliquer les étapes, les essais que vous avez fait avant de trouver la bonne solution.

Sinon, vous indiquez directement la solution trouvée.

Information :

Cette partie précise les conditions de mise en oeuvre.

Vous pouvez faire simple et mettre une copie du programme qui vous a permis d’effectuer ce que vous souhaitiez faire.

Pour les articles de wikis, il est FORTEMENT recommandé de mettre dans le titre “COMMENT FAIRE ceci ou cela…”.  Les moteurs de recherche permettront de trouver plus facilement votre article, si une autre personne a le même problème.

Cet article n'a pas été revu depuis la publication.

Cet article a été créé par Christophe Thomas le 22 mai 2020.