Prompts IA pour la documentation technique

Écrire pour être compris, pas pour remplir

Une IA peut accélérer fortement la rédaction technique si on lui donne un cadre clair: public visé, structure attendue, niveau de détail, points sensibles et exemples utiles.

Les prompts de cette page servent à produire de la documentation lisible, exploitable et cohérente: vue d'ensemble, architecture, flux, dépendances, risques, exemples et résumés.

1. Documentation technique d'un module

Rédige une documentation technique pour le module suivant.

Inclure :
- architecture ;
- flux de données ;
- dépendances ;
- points sensibles.

Format :
1) Vue d'ensemble
2) Architecture
3) Flux
4) Risques / limitations

Module :
{{MODULE_DESCRIPTION}}

Bon prompt de base pour documenter un composant, un service ou un script à partir d'un texte ou d'un extrait de code.

2. Guide de prise en main interne

Rédige un guide de prise en main pour un collègue technique.

Contexte :
{{PROJET_OU_MODULE}}

Inclure :
- objectif du composant ;
- prérequis ;
- structure des fichiers ;
- commandes ou actions fréquentes ;
- erreurs courantes.

Format :
1) À quoi sert ce composant
2) Comment le lancer
3) Comment le modifier
4) Ce qu'il faut surveiller

Pratique pour transformer un savoir oral ou implicite en document de passation utile.

3. Documentation d'architecture

Rédige une page d'architecture pour ce système.

Attendu :
- vue d'ensemble ;
- composants ;
- flux de données ;
- dépendances externes ;
- risques et limites ;
- petit diagramme ASCII.

Contrainte :
- ton clair, professionnel, sans jargon inutile.

À utiliser quand on veut une documentation de synthèse lisible par une équipe technique ou un responsable IT.

4. Rendre une doc plus pédagogique

Reprends cette documentation et rends-la plus pédagogique.

Objectif :
- clarifier les sections ;
- ajouter des exemples ;
- réduire les redites ;
- expliciter les risques et les limites.

Public cible :
{{PUBLIC}}

Utile pour transformer une doc brute ou trop dense en support lisible et réutilisable.

5. Fiche de référence rapide

Crée une fiche de référence technique courte.

Contexte :
{{SUJET}}

Format :
1) A retenir
2) Commandes ou points clés
3) Pièges fréquents
4) Exemple minimal
5) Vérifications rapides

Adapté aux pense-bêtes internes, aux checklists ou aux pages d'aide-mémoire.

6. Synthèse de code vers documentation

Lis ce code et transforme-le en documentation technique.

Attendu :
- rôle du module ;
- fonctions principales ;
- données d'entrée et de sortie ;
- dépendances ;
- limites ;
- exemple d'utilisation.

Code :
{{CODE_SNIPPET}}

Pratique pour accélérer la documentation d'un existant quand il n'existe pas encore de doc propre.

7. Note de mise en production

Rédige une note de mise en production à partir de ces informations.

Inclure :
- prérequis ;
- étapes ;
- contrôles ;
- retour arrière ;
- points de vigilance.

Format :
1) Préparation
2) Exécution
3) Vérification
4) Retour arrière

Utile pour passer d'un savoir épars à une note exploitable avant intervention ou publication.

8. FAQ technique ou support

Transforme cette matière technique en mini FAQ.

Public : {{PUBLIC}}

Attendu :
1) Questions fréquentes
2) Réponses courtes
3) Erreurs classiques
4) Renvois utiles

Pratique pour fournir une forme courte et consultable plutôt qu'un document trop long.

Checklist avant de demander une documentation

Le public cible est-il précisé ?
Le format de sortie est-il défini ?
Les points sensibles à documenter sont-ils nommés ?
Faut-il un exemple, un résumé ou un diagramme ?
Les limites connues doivent-elles apparaître explicitement ?

Usages concrets

Cette page est utile pour rédiger une doc de module, un guide interne VS Code, une note d'architecture, une procédure IT, une page de référence sur un script ou un support de passation entre collègues.

Exemples métier : documentation d'un traitement CSV, fiche d'exploitation d'un script PowerShell, note de cadrage Docker, guide de reprise d'un backend Oracle ou page de procédure interne pour une équipe IT.

Cas du site

Les meilleurs supports documentaires du workspace sont déjà présents : DEPLOIEMENT.md, COMMENCEZ-ICI.txt, LISEZMOI.txt, les tutoriels comme Docker partie 1 et les scripts ou pages techniques autour de start-admin.ps1 ou backup-data.ps1.

Cette page sert aussi à transformer une connaissance dispersée sur l'application locale en fiche claire : point d'entrée, dépendances locales, fichiers JSON, limites de publication et gestes de reprise.

Parcours de documentation utiles

Guide de déploiement : partir d'une note brute, séparer prérequis, exclusions, checklist et tests après publication.
Passation technique : transformer des scripts, pages HTML et savoir oral en guide de prise en main exploitable.
Documentation de module : lire le code ou la structure d'un composant, résumer son rôle, ses flux et ses points sensibles.
Fiche opératoire : produire une page courte orientée exécution, contrôle et retour arrière.

Prompts rapides selon le besoin

Guide interne : demander public cible, structure, prérequis, gestes fréquents et erreurs courantes.
Doc de module : demander rôle, flux, dépendances, limites et exemple minimal.
Runbook ou mise en production : demander préparation, exécution, vérification et retour arrière.
FAQ technique : demander questions fréquentes, réponses courtes, pièges et renvois utiles.

Documentation réutilisable à capitaliser

Quand un même type de document revient souvent, il devient utile de le transformer en cadre stable : instructions de projet pour fixer le ton et les exigences, prompt file pour un cas récurrent, ou agent documentation si la tâche revient avec un vrai volume de travail.

Instructions de projet : fixer langue, structure, niveau de détail, public et validations attendues.
Prompt file : versionner un cadre pour doc de module, runbook, fiche courte ou FAQ.
Agent documentation : spécialiser la production de guides, de synthèses et de notes opératoires.

Prompts pour instructions et bibliotheque documentaire

Instructions documentation : "Propose des instructions de projet pour toute documentation de ce workspace : ton, structure, exemples obligatoires, limites et vérification finale."
Prompt file runbook : "Transforme ce besoin documentaire en prompt file réutilisable pour produire des runbooks avec prérequis, exécution, contrôles et retour arrière."
Agent doc : "Définis un agent documentation chargé de convertir des notes éparses en guide clair, avec rôle, limites, entrées attendues et sorties imposées."

Version débutant vers intermédiaire

Débutant : demander une fiche courte avec sujet, étapes, points de vigilance et vérification finale.
Intermédiaire : ajouter public cible, prérequis, niveau de détail, exemples à inclure et format de sortie exact.
Quand monter d'un cran : si la doc doit tracer une décision, une publication ou un runbook, basculer aussi vers sorties attendues.

Exemples de progression

Procédure de déploiement

Débutant :
Transforme ce document en procédure.

Intermédiaire :
Transforme ../DEPLOIEMENT.md en procédure courte
avec prérequis, exécution, vérification,
retour arrière et erreurs fréquentes.

Guide interne

Débutant :
Fais un guide de prise en main.

Intermédiaire :
Croise ../COMMENCEZ-ICI.txt et ../LISEZMOI.txt.
Public : collègue technique.
Attendu : objectif, prérequis, gestes fréquents,
points sensibles et FAQ courte.

Pages voisines utiles

Pour définir le fond technique avant de rédiger, consultez les prompts architecture. Pour documenter des objets Oracle, SQL, PL/SQL ou une couche d'accès aux données, consultez la page Oracle. Pour choisir une forme de réponse utile, consultez aussi les formulations de sorties attendues. Pour capitaliser instructions, prompt files et agents, consultez aussi les agents, skills et instructions et Copilot / VS Code avance. Pour débuter très simplement, consultez aussi les prompts pour débutants, le parcours débutant par besoin et les checklists pour débutants. Pour garder une trajectoire de travail stable, consultez les workflows et les checklists. Pour les usages par rôle, consultez aussi la page rédaction technique et la page métiers.

← Retour à la rubrique IA