github/comment-code-generate-a-tutorial

Que fait comment-code-generate-a-tutorial ?

Transformez ce script Python en un projet soigné et accessible aux débutants en refactorisant le code, en ajoutant des commentaires pédagogiques clairs et en générant un tutoriel complet en Markdown.

Pourquoi utiliser cette compétence ?

• Rendre le code compréhensible : Ajoutez des commentaires qui expliquent non seulement ce que fait le code, mais pourquoi il le fait et comment il s'intègre dans l'ensemble.
• Structurer un projet : Organisez le script en modules, fonctions et classes clairs, avec une gestion des erreurs et un typage approprié.
• Créer un tutoriel : Générez automatiquement un guide pas à pas en Markdown, idéal pour les débutants ou pour une documentation de projet.
• Gagner du temps : Automatisez la transformation d'un script brut en un projet pédagogique complet.

Comment ça marche ?

1. Fournissez un script Python brut (ou collez son contenu).
2. L'agent analyse le code, identifie les parties à refactoriser et crée une structure de projet.
3. Des commentaires détaillés sont générés et insérés dans le code.
4. Un fichier TUTORIAL.md est créé avec une explication complète du projet, des instructions d'installation, d'utilisation et des concepts clés.

Exemple d'utilisation

# L'agent peut recevoir directement le contenu du script
code_python = """
def add(a, b):
    return a + b

def main():
    x = 10
    y = 20
    result = add(x, y)
    print(result)

if __name__ == "__main__":
    main()
"""

# La compétence transforme cela en un projet structuré avec :
# - Un module calculs.py avec gestion des types
# - Un fichier main.py avec point d'entrée
# - Un fichier TUTORIAL.md expliquant les concepts (fonctions, variables, appel)

Résultat attendu

• Un dossier de projet avec une structure claire (ex. src/, tests/, docs/).
• Un fichier TUTORIAL.md complet, prêt à être publié ou partagé.
• Du code refactorisé avec des commentaires pédagogiques en français (ou dans la langue de votre choix).

Compatibilité

Cette compétence fonctionne avec tous les agents supportant la transformation de code, notamment :

• Claude Code
• Cursor
• Codex
• Et tout autre outil compatible avec des instructions en langage naturel.