open-source-promotion-cheat.../README-fr.md
2019-08-26 14:13:01 +02:00

3.5 KiB
Raw Blame History

oss image

tweet

Open source promotion cheat sheet

Ce cheet sheet résume les étapes importantes à suivre pour promouvoir un projet open-source dans les meilleurs conditions. Il est possible dafficher des informations supplémentaires pour un élément de la liste en cliquant dessus.

Liste de langages disponibles :

Un langage est manquant ? Vous pensez qu'il est possible d'améliorer ce cheat sheet ? Les contributions sont les bienvenues !

1. 🎢 Etape de préparation


😎 Choisir un bon nom de projet

Choisissez un nom que les utilisateurs pourront facilement retenir.

💅 Soigner la présentation du README

Le README est la première choses que les visiteurs verront sur la page de votre projet. Soignez la présentation pour qu'elle soit simple, jolie et agreable à lire. Vous pourrez trouver des bons exemples en cliquant ici.

💪 Mettre en avant les points fort du projet

Identifiez les points forts de votre projet et mettez les en avant de manière à ce qu'il soit perçu en priorité par vos utilisateurs.

Fournissez une démo du projet

Vistors will want to quickly understand the purpose of your project, how it works and how to use it. Providing a demo is the best way to satisfy users. It could be:

  • An animated GIF demonstrating how your project works
  • A link to a live demo

Vos visiteurs voudront rapidement comprendre les tenants et aboutissements de votre projet. Comment ça fonctionne et comment l'utiliser. Fournir une démo est une excellente manière de satisfaire vos visiteurs. La démo peut être sous forme :

  • d'un GIF demontrant comment le projet fonctionne
  • d'un lien vers un démo en ligne

👌 L'installation doit être simplissime

Vous perdrez probablement vos visiteurs si votre projet n'est pas simple à installer.

📘 Creer un documentation soigner et bien structurer

Creating a good documentation is probably the most important step. If you have a small documentation, you can include it within your README. Otherwise, you should probably host it in a separate website. Some open-source projects like vuepress helps you creating clean documentations in a simple way.

Creer un bonne documentation est probablement l'étape la plus importante. Si vous avez une petite documentation il vous sera possible de l'inclure dans votre README. Si celle-ci est volumineuse, le mieux sera de l'extraire vers une application web séparée. Certain projets open source comme vuepress peuvent vous aider à très vite créer un documentation propre et efficace.