L'article explore l'importance des messages de commit clairs et de la documentation complète dans le processus de développement logiciel. L'auteur y décrit sa routine personnelle pour rédiger des messages de commit détaillés et structurés, en utilisant un modèle standard qui inclut le type de modification, la portée, un résumé, une description du problème, la solution apportée, et le contexte supplémentaire. Il souligne également l'impact positif de cette pratique sur la collaboration et la maintenance du code. L'article aborde aussi l'utilisation d'outils comme les hooks Git pour maintenir la qualité des commits et l'intégration de l'IA pour aider à la documentation. Enfin, l'auteur partage son approche pour gérer la documentation à travers différentes étapes du développement, soulignant que ces pratiques sont essentielles pour un développement professionnel efficace.
L'article explore les meilleures pratiques pour rédiger une documentation technique efficace. Il aborde des aspects clés comme la perspective du lecteur, l'accessibilité, les boucles de rétroaction, et les techniques de rédaction. L'auteur souligne l'importance de connaître son audience, d'utiliser un langage clair et des diagrammes bien structurés. Un guide essentiel pour créer des documents techniques utiles et accessibles.
L'auteur insiste sur la nécessité d'écrire : écrire pour documenter la vision, écrire pour réfléchir, écrire pour discuter, etc. C'est une compétence indispensable pour toute personne senior
Tout est dans le titre
La documentation de plein de langages / frameworks rassemblée en un seul site
Présentation de Starlight, un template Astro pour la documentation
Tout est dans le titre
Tout est dans le titre
L'auteur résume une conférence expliquant comment structurer la documentation
Tout est dans le titre
De la doc et manuels informatiques
D'après la documentation, le module doctest cherche des extraits de texte ressemblant à des sessions Python interactives avant de les exécuter, de façon à vérifier que le fonctionnement correspond exactement à la description.
et d'après l'article, il s'agit surtout d'une documentation testée. J'aime beaucoup le principe
Tout est dans le titre
L'auteur effectue le refactoring d'un test en appliquant plusieurs techniques / idées pour le rendre plus lisible.... très intéressant
Tout est dans le titre
L'auteur explique l'intérêt d'utiliser Asciidoc pour générer sa documentation
Tout est dans le titre
Tout est dans le titre
Tout est dans le titre