• Register
    • Login
    • Search
    • Recent
    • Tags
    • Popular
    • Users
    • Groups

    Conseil pour rédiger votre tutoriel.

    Tutoriels des membres
    5
    10
    3773
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • robin4002
      robin4002 Moddeurs confirmés Rédacteurs Administrateurs last edited by robin4002

      Bonjour,
      Vous pouvez trouver ici quelques astuces pour bien rédiger votre tutoriel pour qu’il ait plus de chance d’être accepté.

      La présentation

      Il suffit d’appliquer le modèle
      La partie crédit est prévu pour citer toutes les personnes qui ont contribué au tutoriel, vous avez donc bien sûr le droit même l’obligation d’y ajouter votre nom.

      Le code java doit être mis dans la balise java et être formaté correctement. D’ailleurs dans les paramètres de votre formateur, veuillez utiliser 4 espaces et non un caractère de tabulation, car le forum ne les conserve pas lors de l’édition.
      Ne mettez pas les balises Java à l’intérieur d’un spoiler, la balise Java ajoute automatiquement une barre de scroll si le code est long.
      Le format de la balise java est le suivant :
      ```java
      package …;

      public class Block…
      ```

      Pour les fichiers JSON ou autre texte, le format est le même, mettez simplement json à la place de java, ou rien si c’est du texte brute.

      Nous vous recommandons aussi de vous renseigner sur les possibilités du markdown et sur les extensions de ce dernier qui sont en place sur le forum.

      L’orthographe et la grammaire

      Un effort minimum est demandé pour l’orthographe et la grammaire. Qar ci vou écrivé com sa sa va vrèmen pa le fèr. Il existe des sites comme bonpatron, languagetool qui vous indiquent la plupart de vos erreurs de grammaire et d’orthographe. Dans tout les cas un de nos correcteurs corrigera le tutoriel, mais il est mieux de ne pas le faire souffrir ;).

      La précision

      Il est également très important d’expliquer tout le code, sauf s’ils ont déjà été vu dans un autre tutoriel. On arrive beaucoup mieux à apprendre quelque chose qu’on comprend, c’est pour cette raison que plus vous apporterez de précision à vos codes, plus votre tutoriel sera de bonne qualité. C’est également pour cette raison que si vous ne comprenez pas un code, il faut demander, même si vous trouvez la question bête.

      Évitez donc de balancer un code sans explication. D’ailleurs, évitez aussi de donner des codes tout fait, par exemple, il est mieux de dire “ajoutez extends Item après le nom de la classe et ajoutez un constructeur à votre item” que de donner le code de la classe fini.
      Pourquoi ?  
      À nouveau, c’est pour la simple et bonne raison que les copier/coller sont mauvais pour la mémoire. Si le lecteur voit le code tout fait, il va être tenté de le copier/coller. Or si vous expliquez étape par étape, le lecteur va recopier à la main de code. Vous pouvez toujours mettre le code complet à la fin du tutoriel pour faire un aperçu globale ou mettre un lien github.

      Attention également à ne pas laisser des noms obfusqués dans votre code. Il ne doit avoir aucuns paramètres nommés “par1”, “par2”, etc. de variables field_xxx ou encore de fonctions func_xxx sauf si sont des références au code de Minecraft.

      Contribuer au Github du mod tutoriel

      Github permet de faire de l’open source, il est donc possible de contribuer à un projet déjà existant. Pour commencer, créez un compte github. Une fois créé, rendez-vous sur github du ModTutoriel et cliquez sur le bouton “fork”
      Vous aurez donc une copie du projet sur votre github. Ensuite clonez le projet en local à l’aide de git ou de github for windows/mac et copier le dossier src dans votre dossier de votre setup de forge.
      Vous avez maintenant les sources du mod dans eclipse, vous pouvez coder dessus. Une fois vos ajouts terminés, copier le dossier src dans le dossier du projet github. Lancez l’application github, commitez, et synchroniser. Une fois fait, allez sur le fork du projet ( http://www.github.com/votrepseudogithub/ModTutoriel17/) et cliquez sur le bouton pull request. Mettez un nom au pull et une description avec le lien du tutoriel. Je m’occuperai ensuite soit de refuser, soit d’accepter.

      1 Reply Last reply Reply Quote 0
      • Gugu
        Gugu last edited by

        Très pratique !

        "If you have a comprehensive explanation for everything then it decreases uncertainty and anxiety and reduces your cognitive load. And if you can use that simplifying algorithm to put yourself on the side of moral virtue then you’re constantly a good person with a minimum of effort."
        ― Jordan B. Peterson

        1 Reply Last reply Reply Quote 0
        • 0nit
          0nit last edited by

          J’ai fait mon premier GitHub 😄

          Mes tutoriels:

          >! [1.6.x] - Le kit d'outils
          >! [1.6.x] - Les recettes du four

          1 Reply Last reply Reply Quote 0
          • utybo
            utybo last edited by

            Vous pouvez faire un tuto qui parle de Github svp?

            Moddeur à la retraite et développeur de trucs en Java.

            J'aide les gens comme je peux, alors si mon message v…

            1 Reply Last reply Reply Quote 0
            • robin4002
              robin4002 Moddeurs confirmés Rédacteurs Administrateurs last edited by

              Je vais faire ça pour samedi.

              1 Reply Last reply Reply Quote 0
              • utybo
                utybo last edited by

                OK merci! 🙂

                Moddeur à la retraite et développeur de trucs en Java.

                J'aide les gens comme je peux, alors si mon message v…

                1 Reply Last reply Reply Quote 0
                • kevin_68
                  kevin_68 Moddeurs confirmés last edited by

                  Plutôt dimanche entre 0h00 et 2h00.
                  cf: dernier tuto.


                  Mettez à jours vers la dernière version stable (1.8.9 voir même…

                  1 Reply Last reply Reply Quote 0
                  • robin4002
                    robin4002 Moddeurs confirmés Rédacteurs Administrateurs last edited by

                    Ajout d’une note concernant l’éditeur.

                    1 Reply Last reply Reply Quote 0
                    • robin4002
                      robin4002 Moddeurs confirmés Rédacteurs Administrateurs last edited by

                      Retrait de la note concernant l’éditeur (plus d’actualité), ajout d’une instruction concernant les balises java et code ainsi qu’une instruction concernant les variables obfusqués.

                      1 Reply Last reply Reply Quote 0
                      • robin4002
                        robin4002 Moddeurs confirmés Rédacteurs Administrateurs last edited by

                        Légère mise à jour du post, j’ai ajouté le format pour le code Java en Markdown et deux liens sur l’utilisation du Markdown.

                        1 Reply Last reply Reply Quote 0
                        • 1 / 1
                        • First post
                          Last post
                        Design by Woryk
                        Contact / Mentions Légales

                        MINECRAFT FORGE FRANCE © 2018

                        Powered by NodeBB