Introduction

Après avoir fait le plein d’idées, l’objectif est de les rédiger pour que vous ayez du contenu à mettre sur votre site web.

Pour la rédaction, vous n’avez pas le droit de vous servir d’un LLM et ce parce qu’il est important que vous arriviez à avoir votre propre voix à l’oral comme à l’écrit. Votre capacité d’écrire influence votre capacité de réfléchir, de mettre en forme ce à quoi vous pensez, de formuler des questions et votre capacité de vous exprimer à l’oral.

Curieusement la capacité d’écrire peut aussi vous rendre meilleur lorsqu’il s’agit de parler à… un LLM. Vous permettant d’obtenir de meilleures réponses à vos questions.

C’est un processus où le temps investit n’est pas perdu.

Consignes

En utilisant les conseils de ce sujet, et sans vous servir d’un LLM, rédigez les idées que vous avez eu lors du TP d’idéation. Mettez-vous dans une note journalière, titrez “EXP101 rédaction” et faites un lien vers votre note qui correspond au module. Chaque jour où vous travaillez sur ce sujet, continuez dans une nouvelle note journalière.

Sans respecter de structure particulière, écrivez vos jets, sans jamais les effacer. Vous pouvez séparer les jets avec des sous-titres ou avec des bares horizontales :

bla-bla-bla

---

bla-bla-bla

Lorsque vous pensez être arrivés à un jet final, copiez-le dans la note du module et titrez-le correctement. Exemple : “Description Projet Cat”, “Présentation accueil”. Avant ou après le texte, ajoutez un lien vers la note source du jet (votre note journalière).

Les éléments que vous devez rédiger (extraits du projet) sont :

• pour la page d’accueil
  • courte description de votre parcours et des projets que vous avez réalisés et ce que vous aspirez a devenir
• pour les pages projet
  • des illustrations légendées (qu’il faut sélectionner)
  • un rappel des charges du projet
  • les technologies utilisées
  • les contraintes particulières (comme la qualité du code et respect d’une norme (un codding style), ou l’interdiction d’utiliser la bibliothèque standard)
• pour la page de liste des projets
  • une description courte des projets

Les descriptions de projets doivent avoir les déclinaisons suivantes :

• une destinée à un profil technique ;
• une destinée à un profil non-technique ;
• une servant de résumé à afficher sur la liste des projets.

Quelques techniques d’écritures

Écrire, écrire, écrire, dis comme ça c’est bien beau mais comment est-ce qu’on s’y prend vraiment ? Nous allons voir quelques techniques qui peuvent vous aider à vous lancer, à vous recentrer ou à vous relire.

Jets & brouillons

N’hésitez pas à commencer par écrire ce que vous pensez, quitte à vous répéter, quitte à essayer plusieurs formulations de phrases, quitte à faire plein de fautes. N’effacez pas. Si vous voulez recommencer, faites un nouveau jet, donnez lui un autre numéro, donnez lui pour nom la date et l’heure et commencez par écrire vos intentions.

Le manifeste du Cult of Done propose quelques principes, que j’ai traduit, qui peuvent aider à ce mettre dans le bon état d’esprit :

• Premier principe
  • There are three states of being. Not knowing, action and completion.
  • Il y a trois états dans lesquels vous pouvez être. L’ignorance, l’action et la complétion.
• Second principe
  • Accept that everything is a draft. It helps to get it done.
  • Acceptez que tout est un brouillon. Cela vous aide à vous lancer.
• Troisième principe
  • There is no editing stage.
  • Il n’y a pas de phase de modification.
• Sixième principe
  • The point of being done is not to finish but to get other things done.
  • Le but d’avoir fait n’est pas de finir, mais de pouvoir passer à autre chose.
• Neuvième principe
  • People without dirty hands are wrong. Doing something makes you right.
  • Ceux qui n’ont pas les mains sales ont tord. Faire quelque chose vous donne raison.
• Dixième principe
  • Failure counts as done. So do mistakes.
  • Échouer, c’est avoir fait quelque chose. Alors faites des erreurs.

Structure

Tant que vous êtes entrain d’écrire vous n’avez pas besoin de réfléchir à une structure. Mais une fois que vous aurez fini d’écrire, vous pourrez essayer de dériver une structure de votre contenu, en extrayant le contenu que vous aimer le plus de chacun de vos jets.

Écrire comme on parle

Si vous n’arrivez pas à rédiger une idée, un bon point de départ est d’essayer de le faire avec votre “voix” orale. Écrivez comme vous parleriez à l’oral.

“J’ai travaillé sur le projet cat, dans lequel il fallait lire des fichiers et les écrire sur la sortie standard.” – Phrase orale, voix active.

Ensuite, vous pouvez essayer d’adapter le ton, une description de projet peut être écrite à la façon d’un journal, ou elle peut l’être à la façon d’une encyclopédie.

“Le projet cat est un projet de recode d’une partie des fonctionnalités de l’utilitaire UNIX du même nom. Une des fonctionnalités est la lecture de fichiers passés en argument et leur écriture sur la sortie standard.” – Style plus académique, formel avec une construction attributive.

Faites attention aussi à ne pas faire des phrases trop longues avec beaucoup de propositions subordonnées ou de conjonctions. Quand vous vous relisez, demandez vous si une phrase peut être coupée. Essayez avec et sans découpage. Gardez la version qui, selon vous, ce lit le mieux.

Enfin, dans votre rédaction finale, évitez les formulations comme “on nous a demandé de faire ceci” et dites plutôt “l’objectif du projet c’est […], il est formateur car, […], il été nécessaire de résoudre [tel problème]”.

Adverbe quand tu nous tiens…

Certains adverbes, ou certaines locution adverbiales ont tendance à charger le texte sans apporter de sens. Les éviter peut rendre votre texte plus sérieux et plus facile à lire à la fois.

Ainsi je vous conseille d’éviter les synonymes de “simplement”, “facilement” qui sont sur-représentés dans les productions étudiantes.

Pareil dans les productions à l’oral pour les locutions comme “en fait” ou “du coup”. Elles aident généralement assez peu le propos.

Il n’est pas forcément question de les proscrire, mais y faire attention peut vous aider à mieux écrire et relire. Peut-être y a-t’il d’autres locutions, que vous avez remarquées, qui peuvent être bonnes à éviter ?

Cible

En fonction de votre cible, nous n’allez pas vous exprimer pareil. Dans le cadre de votre auto-promotion qui sont les cibles possibles ?

Lorsque vous vous adressez a un profil technique vous pouvez inclure des détails technique, et omettre des évidences, comme c’est qu’est un terminal ou un programme utilisable en ligne de commande (CLI). À l’inverse, ce sont ces détails qui vont être intéressant à préciser quand vous-vous adressez à quelqu’un qui ne code pas (comme un vibe-coder ou un membre de votre famille qui est chargé de resources humaines).

Alors quand vous écrivez, demandez-vous : à qui vous adressez-vous ? Quels détails utiliser ?