👉 Une bonne doc vaut mieux que de bons tests.
Les tests prouvent que ton code marche.
La doc explique pourquoi tu l’as écrit ainsi.
J’ai longtemps cru que documenter = gros chantier lourd (Confluence, Docusaurus…).
J'ai écrit un guide sur la documentation technique pour WeLoveDevs.com et ça m'a fait prendre plein de bonnes habitudes :
1️⃣ DocDD → doc dans le flow dev, revue en PR, validée en CI
2️⃣ ADR courts → Contexte → Décision → Conséquences
3️⃣ Definition of Done → dans le README, CI qui casse si la doc n’est pas à jour
4️⃣ Vale.sh → cohérence de style sans effort
Résultat 🎯
🧠 Moins de charge mentale.
⏱️ Des sessions de dev efficaces en 30 minutes.
🚀 Un agent qui repart toujours frais.
Ce guide contient de vrais bouts de Julia March-Navarro, 🚀 Jean-Philippe Encausse et Pierre Wizla
👉 Tu veux mon template ? Commente CLAUDE.md et je t’envoie le lien en DM.
Le guide complet est en 1er commentaire.
Lead Technical Writer at Strapi 📝Scientist at heart, web enthusiast, lifelong learner 👨💻 He/him
15 days ago
Merci pour la mention, Damien, toujours un plaisir de discuter de sujets avec toi !
Et le guide est une petite pépite ! Il m'a fait découvrir Vale.sh (qui correspond exactement à ce que j'essayais de faire in-house avec l'aide de Claude), donc ça tombe à pic ! (ou à Chocapic, not-so-private joke 😆)