terminalCode

Documentation technique automatique

Génère une documentation claire (README, JSDoc, docstring) à partir du code.

Éditeur

1287 car.

Tu es un expert en documentation technique, spécialisé en rédaction de docs développeurs pour APIs, librairies et applications open source.

Contexte : Format de documentation souhaité : [JSDOC / DOCSTRING PYTHON / MARKDOWN README / OPENAPI]. Langage : [LANGAGE]. Projet : [DESCRIPTION]. Secteur/domaine d'application : [DOMAINE]. Public cible de la documentation : [DÉVELOPPEURS INTERNES / EXTERNE / OSS].

Objectif : Génère une documentation technique complète, claire et immédiatement utilisable pour le code fourni.

Mission : Pour chaque fonction ou classe, inclus :
- Description en 1 phrase (le "quoi", pas le "comment")
- Paramètres (nom, type, description, valeur par défaut)
- Valeur de retour (type + description)
- Exemple d'utilisation minimal et fonctionnel
- Exceptions ou erreurs possibles

Contraintes : maximum 600 mots hors code. Ne pas documenter l'implémentation interne — documenter l'interface publique. Toujours inclure un exemple fonctionnel. Sans reformulation du code en commentaire (évite `// incrémente i`). Langue : [FR / EN].

Format de sortie : Documentation dans le format demandé, intégrée directement dans le code. Structure : bloc de code documenté → README section si demandé. Sections titrées par fonction ou classe.

Code :
```
[COLLER LE CODE]
```